FS/bin/freeside-queued

   1 #!/usr/bin/perl -w
   2
   3 use strict;
   4 use vars qw( $log_file $sigterm $sigint $kids $max_kids );
   5 use subs qw( _die _logmsg );
   6 use Fcntl qw(:flock);
   7 use POSIX qw(setsid);
   8 use Date::Format;
   9 use IO::File;
  10 use FS::UID qw(adminsuidsetup forksuidsetup driver_name dbh);
  11 use FS::Record qw(qsearch qsearchs);
  12 use FS::queue;
  13 use FS::queue_depend;
  14
  15 # no autoloading just yet
  16 use FS::cust_main;
  17 use FS::svc_acct;
  18 use Net::SSH 0.07;
  19 use FS::part_export;
  20
  21 $max_kids = '10'; #guess it should be a config file...
  22 $kids = 0;
  23
  24 my $user = shift or die &usage;
  25
  26 #my $pid_file = "/var/run/freeside-queued.$user.pid";
  27 my $pid_file = "/var/run/freeside-queued.pid";
  28
  29 &daemonize1;
  30
  31 sub REAPER { my $pid = wait; $SIG{CHLD} = \&REAPER; $kids--; }
  32 $SIG{CHLD} =  \&REAPER;
  33
  34 $sigterm = 0;
  35 $sigint = 0;
  36 $SIG{INT} = sub { warn "SIGINT received; shutting down\n"; $sigint++; };
  37 $SIG{TERM} = sub { warn "SIGTERM received; shutting down\n"; $sigterm++; };
  38
  39 my $freeside_gid = scalar(getgrnam('freeside'))
  40   or die "can't setgid to freeside group\n";
  41 $) = $freeside_gid;
  42 $( = $freeside_gid;
  43 #if freebsd can't setuid(), presumably it can't setgid() either.  grr fleabsd
  44 ($(,$)) = ($),$();
  45 $) = $freeside_gid;
  46
  47 $> = $FS::UID::freeside_uid;
  48 $< = $FS::UID::freeside_uid;
  49 #freebsd is sofa king broken, won't setuid()
  50 ($<,$>) = ($>,$<);
  51 $> = $FS::UID::freeside_uid;
  52
  53 $ENV{HOME} = (getpwuid($>))[7]; #for ssh
  54 adminsuidsetup $user;
  55
  56 $log_file = "/usr/local/etc/freeside/queuelog.". $FS::UID::datasrc;
  57
  58 &daemonize2;
  59
  60 $SIG{__DIE__} = \&_die;
  61 $SIG{__WARN__} = \&_logmsg;
  62
  63 warn "freeside-queued starting\n";
  64
  65 my $warnkids=0;
  66 while (1) {
  67
  68   #prevent runaway forking
  69   if ( $kids >= $max_kids ) {
  70     warn "WARNING: maximum $kids children reached\n" unless $warnkids++;
  71     sleep 1; #waiting for signals is cheap
  72     next;
  73   }
  74   $warnkids=0;
  75
  76   my $nodepend = driver_name eq 'mysql'
  77    ? ''
  78    : 'AND 0 = ( SELECT COUNT(*) FROM queue_depend'.
  79      ' WHERE queue_depend.jobnum = queue.jobnum ) ';
  80
  81   #my($job, $ljob);
  82   #{
  83   #  my $oldAutoCommit = $FS::UID::AutoCommit;
  84   #  local $FS::UID::AutoCommit = 0;
  85   $FS::UID::AutoCommit = 0;
  86   my $dbh = dbh;
  87
  88   my $job = qsearchs(
  89     'queue',
  90     { 'status' => 'new' },
  91     '',
  92     driver_name eq 'mysql'
  93       ? "$nodepend ORDER BY jobnum LIMIT 1 FOR UPDATE"
  94       : "$nodepend ORDER BY jobnum FOR UPDATE LIMIT 1"
  95   ) or do {
  96     $dbh->commit or die $dbh->errstr; #if $oldAutoCommit;
  97     sleep 5; #connecting to db is expensive
  98     next;
  99   };
 100
 101   if ( driver_name eq 'mysql'
 102        && qsearch('queue_depend', { 'jobnum' => $job->jobnum } ) ) {
 103     $dbh->commit or die $dbh->errstr; #if $oldAutoCommit;
 104     sleep 5; #would be better if mysql could do everything in query above
 105     next;
 106   }
 107
 108   my %hash = $job->hash;
 109   $hash{'status'} = 'locked';
 110   my $ljob = new FS::queue ( \%hash );
 111   my $error = $ljob->replace($job);
 112   die $error if $error;
 113
 114   $dbh->commit or die $dbh->errstr; #if $oldAutoCommit;
 115
 116   $FS::UID::AutoCommit = 1;
 117   #}
 118
 119   my @args = $ljob->args;
 120
 121   defined( my $pid = fork ) or do {
 122     warn "WARNING: can't fork: $!\n";
 123     my %hash = $job->hash;
 124     $hash{'status'} = 'failed';
 125     $hash{'statustext'} = "[freeside-queued] can't fork: $!";
 126     my $ljob = new FS::queue ( \%hash );
 127     my $error = $ljob->replace($job);
 128     die $error if $error;
 129     next; #don't increment the kid counter
 130   };
 131
 132   if ( $pid ) {
 133     $kids++;
 134   } else { #kid time
 135
 136     #get new db handle
 137     $FS::UID::dbh->{InactiveDestroy} = 1;
 138
 139     forksuidsetup($user);
 140
 141     #auto-use export classes...
 142     if ( $ljob->job =~ /(FS::part_export::\w+)::/ ) {
 143       my $class = $1;
 144       eval "use $class;";
 145       if ( $@ ) {
 146         warn "job use $class failed";
 147         my %hash = $ljob->hash;
 148         $hash{'status'} = 'failed';
 149         $hash{'statustext'} = $@;
 150         my $fjob = new FS::queue( \%hash );
 151         my $error = $fjob->replace($ljob);
 152         die $error if $error;
 153         exit; #end-of-kid
 154       };
 155     }
 156
 157     my $eval = "&". $ljob->job. '(@args);';
 158     warn "running $eval";
 159     eval $eval; #throw away return value?  suppose so
 160     if ( $@ ) {
 161       warn "job $eval failed";
 162       my %hash = $ljob->hash;
 163       $hash{'status'} = 'failed';
 164       $hash{'statustext'} = $@;
 165       my $fjob = new FS::queue( \%hash );
 166       my $error = $fjob->replace($ljob);
 167       die $error if $error;
 168     } else {
 169       $ljob->delete;
 170     }
 171
 172     exit;
 173     #end-of-kid
 174   }
 175
 176 } continue {
 177   if ( $sigterm ) {
 178     warn "received TERM signal; exiting\n";
 179     exit;
 180   }
 181   if ( $sigint ) {
 182     warn "received INT signal; exiting\n";
 183     exit;
 184   }
 185 }
 186
 187 sub usage {
 188   die "Usage:\n\n  freeside-queued user\n";
 189 }
 190
 191 sub _die {
 192   my $msg = shift;
 193   unlink $pid_file if -e $pid_file;
 194   _logmsg($msg);
 195 }
 196
 197 sub _logmsg {
 198   chomp( my $msg = shift );
 199   my $log = new IO::File ">>$log_file";
 200   flock($log, LOCK_EX);
 201   seek($log, 0, 2);
 202   print $log "[". time2str("%a %b %e %T %Y",time). "] [$$] $msg\n";
 203   flock($log, LOCK_UN);
 204   close $log;
 205 }
 206
 207 sub daemonize1 {
 208
 209   chdir "/" or die "Can't chdir to /: $!";
 210   open STDIN, '/dev/null'   or die "Can't read /dev/null: $!";
 211   defined(my $pid = fork) or die "Can't fork: $!";
 212   if ( $pid ) {
 213     print "freeside-queued started with pid $pid\n"; #logging to $log_file\n";
 214     exit unless $pid_file;
 215     my $pidfh = new IO::File ">$pid_file" or exit;
 216     print $pidfh "$pid\n";
 217     exit;
 218   }
 219   #open STDOUT, '>/dev/null'
 220   #                          or die "Can't write to /dev/null: $!";
 221   #setsid                  or die "Can't start a new session: $!";
 222   #open STDERR, '>&STDOUT' or die "Can't dup stdout: $!";
 223
 224 }
 225
 226 sub daemonize2 {
 227   open STDOUT, '>/dev/null'
 228                             or die "Can't write to /dev/null: $!";
 229   setsid                  or die "Can't start a new session: $!";
 230   open STDERR, '>&STDOUT' or die "Can't dup stdout: $!";
 231 }
 232
 233 =head1 NAME
 234
 235 freeside-queued - Job queue daemon
 236
 237 =head1 SYNOPSIS
 238
 239   freeside-queued user
 240
 241 =head1 DESCRIPTION
 242
 243 Job queue daemon.  Should be running at all times.
 244
 245 user: from the mapsecrets file - see config.html from the base documentation
 246
 247 =head1 VERSION
 248
 249 =head1 BUGS
 250
 251 =head1 SEE ALSO
 252
 253 =cut
 254