| 1 | # -*- perl -*- | ||
| 2 | |||
| 3 | # Copyright (c) 2008 by AdCopy | ||
| 4 | # Author: Jeff Weisberg | ||
| 5 | # Created: 2008-Dec-01 16:02 (EST) | ||
| 6 | # Function: daemonization + logging | ||
| 7 | # | ||
| 8 | # $Id: Daemon.pm,v 1.13 2010/10/30 20:27:53 jaw Exp $ | ||
| 9 | |||
| 10 | package AC::Daemon; | ||
| 11 | use AC::Import; | ||
| 12 | use Sys::Syslog; | ||
| 13 | use POSIX; | ||
| 14 | use strict; | ||
| 15 | |||
| 16 | BEGIN { | ||
| 17 | # use it if we've got it | ||
| 18 | eval { | ||
| 19 | require AC::Error; AC::Error->import(); | ||
| 20 | }; | ||
| 21 | if($@){ | ||
| 22 | *daemon_error = sub {}; | ||
| 23 | *stack_trace = sub {}; | ||
| 24 | } | ||
| 25 | } | ||
| 26 | |||
| 27 | our @EXPORT = qw(daemonize run_and_watch initlog debugmsg verbose problem fatal); | ||
| 28 | |||
| 29 | my $childpid; | ||
| 30 | my $verbose = 1; | ||
| 31 | my $nomail = 0; | ||
| 32 | my $syslog; | ||
| 33 | my @maybe_argv = @ARGV; # save for restart (might not be available) | ||
| 34 | |||
| 35 | sub daemonize { | ||
| 36 | my $tout = shift; | ||
| 37 | my $name = shift; | ||
| 38 | my $argv = shift; | ||
| 39 | |||
| 40 | fork && exit; # background ourself | ||
| 41 | $verbose = 0; | ||
| 42 | |||
| 43 | my @argv = $argv ? @$argv : @maybe_argv; | ||
| 44 | |||
| 45 | close STDIN; open( STDIN, "/dev/null" ); | ||
| 46 | close STDOUT; open( STDOUT, "> /dev/null" ); | ||
| 47 | close STDERR; open( STDERR, "> /dev/null" ); | ||
| 48 | setsid(); | ||
| 49 | |||
| 50 | $SIG{QUIT} = $SIG{INT} = $SIG{TERM} = sub { _signal($name, @_) }; | ||
| 51 | |||
| 52 | if( $name ){ | ||
| 53 | # save pid file | ||
| 54 | open(PID, "> /var/run/$name.pid"); | ||
| 55 | print PID "$$\n"; | ||
| 56 | print PID "# @argv\n"; | ||
| 57 | close PID; | ||
| 58 | } | ||
| 59 | |||
| 60 | # run as 2 processes | ||
| 61 | while(1){ | ||
| 62 | $childpid = fork; | ||
| 63 | die "cannot fork: $!\n" unless defined $childpid; | ||
| 64 | if( $childpid ){ | ||
| 65 | # parent | ||
| 66 | wait; | ||
| 67 | $childpid = undef; | ||
| 68 | sleep $tout; | ||
| 69 | }else{ | ||
| 70 | # child | ||
| 71 | return; | ||
| 72 | } | ||
| 73 | } | ||
| 74 | } | ||
| 75 | |||
| 76 | sub _signal { | ||
| 77 | my $name = shift; | ||
| 78 | |||
| 79 | verbose( "caught signal SIG$_[0] - exiting" ); | ||
| 80 | |||
| 81 | if( $childpid > 1 ){ | ||
| 82 | # kill child process + wait for it to exit | ||
| 83 | unlink "/var/run/$name.pid" if $name; | ||
| 84 | kill "TERM", $childpid; | ||
| 85 | wait; | ||
| 86 | } | ||
| 87 | |||
| 88 | exit; | ||
| 89 | } | ||
| 90 | |||
| 91 | sub initlog { | ||
| 92 | my $name = shift; | ||
| 93 | my $facil = shift; | ||
| 94 | my $quiet = shift; | ||
| 95 | |||
| 96 | unless( $syslog ){ | ||
| 97 | openlog( $name, 'ndelay, pid', $facil ); | ||
| 98 | $syslog = 1; | ||
| 99 | } | ||
| 100 | |||
| 101 | $nomail = $quiet; | ||
| 102 | } | ||
| 103 | |||
| 104 | sub run_and_watch { | ||
| 105 | my $optf = shift; | ||
| 106 | my $func = shift; | ||
| 107 | |||
| 108 | $SIG{USR2} = \&_send_trace; | ||
| 109 | |||
| 110 | eval { | ||
| 111 | $func->(); | ||
| 112 | }; | ||
| 113 | if( my $e = $@ ){ | ||
| 114 | if( $optf ){ | ||
| 115 | $e .= "\n\n" . stack_trace(); | ||
| 116 | verbose( "UNCAUGHT ERROR: $e" ); | ||
| 117 | }else{ | ||
| 118 | fatal( "UNCAUGHT ERROR: $e" ); | ||
| 119 | } | ||
| 120 | } | ||
| 121 | } | ||
| 122 | |||
| 123 | sub debugmsg { | ||
| 124 | my $msg = shift; | ||
| 125 | |||
| 126 | syslog( 'debug', '%s', $msg ) if $syslog; | ||
| 127 | _to_stderr( $msg ) if $verbose; | ||
| 128 | } | ||
| 129 | |||
| 130 | sub verbose { | ||
| 131 | my $msg = shift; | ||
| 132 | |||
| 133 | syslog( 'info', '%s', $msg ) if $syslog; | ||
| 134 | _to_stderr( $msg ) if $verbose; | ||
| 135 | } | ||
| 136 | |||
| 137 | sub problem { | ||
| 138 | my $msg = shift; | ||
| 139 | |||
| 140 | daemon_error( $msg ) unless $nomail; | ||
| 141 | syslog( 'err', '%s', $msg ) if $syslog; | ||
| 142 | _to_stderr( $msg ); | ||
| 143 | } | ||
| 144 | |||
| 145 | sub fatal { | ||
| 146 | my $msg = shift; | ||
| 147 | |||
| 148 | daemon_error( $msg ) unless $nomail; | ||
| 149 | syslog( 'err', '%s', $msg ) if $syslog; | ||
| 150 | _to_stderr( $msg ); | ||
| 151 | exit -1; | ||
| 152 | } | ||
| 153 | |||
| 154 | sub _to_stderr { | ||
| 155 | my $msg = shift; | ||
| 156 | |||
| 157 | my $t = strftime '%H:%M:%S', localtime; | ||
| 158 | print STDERR "[$$ $t] $msg\n"; | ||
| 159 | |||
| 160 | } | ||
| 161 | |||
| 162 | sub _send_trace { | ||
| 163 | |||
| 164 | # email a stack trace to developer | ||
| 165 | problem("sigusr2"); | ||
| 166 | } | ||
| 167 | |||
| 168 | |||
| 169 | =head1 NAME | ||
| 170 | |||
| 171 | AC::Daemon - daemon program utility functions. | ||
| 172 | |||
| 173 | =head1 SYNOPSIS | ||
| 174 | |||
| 175 | use AC::Daemon; | ||
| 176 | use strict; | ||
| 177 | |||
| 178 | initlog( 'program', 'local5' ); | ||
| 179 | daemonize( 5, 'program', \@ARGV ) unless $opt{foreground}; | ||
| 180 | verbose( 'starting.' ); | ||
| 181 | |||
| 182 | run_and_watch( $opt{foreground}, \&myfunction ); | ||
| 183 | exit; | ||
| 184 | |||
| 185 | =cut | ||
| 186 | |||
| 187 | |||
| 188 | 1; | ||
| 189 |