Proc-Daemon-0.14/0000755000000000000000000000000011572120440012234 5ustar rootrootProc-Daemon-0.14/MANIFEST0000644000000000000000000000030611572120440013364 0ustar rootrootChanges lib/Proc/Daemon.pm lib/Proc/Daemon.pod Makefile.PL MANIFEST README t/01_loadmodule.t t/02_testmodule.t META.yml Module meta-data (added by MakeMaker) Proc-Daemon-0.14/lib/0000755000000000000000000000000011572120440013002 5ustar rootrootProc-Daemon-0.14/lib/Proc/0000755000000000000000000000000011572120440013705 5ustar rootrootProc-Daemon-0.14/lib/Proc/Daemon.pod0000644000000000000000000002530711572107304015627 0ustar rootroot =head1 NAME Proc::Daemon - Run Perl program(s) as a daemon process. =head1 SYNOPSIS use Proc::Daemon; $daemon = Proc::Daemon->new( work_dir => '/my/daemon/directory', ..... ); $Kid_1_PID = $daemon->Init; unless ( $Kid_1_PID ) { # code executed only by the child ... } $Kid_2_PID = $daemon->Init( { work_dir => '/other/daemon/directory', exec_command => 'perl /home/my_script.pl', } ); $pid = $daemon->Status( ... ); $stopped = $daemon->Kill_Daemon( ... ); =head1 DESCRIPTION This module can be used by a Perl program to initialize itself as a daemon or to execute (C) a system command as daemon. You can also check the status of the daemon (alive or dead) and you can kill the daemon. A daemon is a process that runs in the background with no controlling terminal. Generally servers (like FTP, HTTP and SIP servers) run as daemon processes. Do not make the mistake to think that a daemon is a server. ;-) Proc::Daemon does the following: =over 4 =item 1 The script forks a child. =item 2 The child changes the current working directory to the value of 'work_dir'. =item 3 The child clears the file creation mask. =item 4 The child becomes a session leader, which detaches the program from the controlling terminal. =item 5 The child forks another child (the final daemon process). This prevents the potential of acquiring a controlling terminal at all and detaches the daemon completely from the first parent. =item 6 The second child closes all open file descriptors (unless you define C and/or C). =item 7 The second child opens STDIN, STDOUT and STDERR to the location defined in the constructor (C). =item 8 The second child returns to the calling script, or the program defined in 'exec_command' is executed and the second child never returns. =item 9 The first child transfers the PID of the second child (daemon) to the parent. Additionally the PID of the daemon process can be written into a file if 'pid_file' is defined. Then the first child exits. =item 10 If the parent script is looking for a return value, then the PID(s) of the child/ren will be returned. Otherwise the parent will exit. =back NOTE: Because of the second fork the daemon will not be a session-leader and therefore Signals will not be send to other members of his process group. If you need the functionality of a session-leader you may want to call POSIX::setsid() manually at your daemon. INFO: Since C is not performed the same way on Windows systems as on Linux, this module does not work with Windows. Patches appreciated! =head1 CONSTRUCTOR =over 4 =item new ( %ARGS ) The constructor creates a new Proc::Daemon object based on the hash %ARGS. The following keys from %ARGS are used: =over 8 =item work_dir Defines the path to the working directory of your daemon. Defaults to C. =item setuid Sets the real user identifier (C<< $< >>) and the effective user identifier (C<< $> >>) for the daemon process using C, in case you want to run your daemon under an other user then the parent. Obviously the first user must have the rights to switch to the new user otherwise it will stay the same. It is helpful to define the argument C if you start your script at boot time by init with the superuser, but wants the daemon to run under a normal user account. =item child_STDIN Defines the path to STDIN for your daemon. Defaults to C. Default Mode is '<' (read). You can define other Mode the same way as you do using Perls C in a two-argument form. =item child_STDOUT Defines the path where the output of your daemon will go. Defaults to C. Default Mode is '+>' (write/read). You can define other Mode the same way as you do using Perls C in a two-argument form. =item child_STDERR Defines the path where the error output of your daemon will go. Defaults to C. Default Mode is '+>' (write/read). You can define other Mode the same way as you do using Perls C in a two-argument form, see example below. =item dont_close_fh If you define it, it must be an arrayref with file handles you want to preserve from the parent into the child (daemon). This may be the case if you have code below a C<__DATA__> token in your script or module called by C or C. dont_close_fh => [ 'main::DATA', 'PackageName::DATA', $my_filehandle, ... ], You can add any kind of file handle to the array (expression in single quotes or a scalar variable), including 'STDIN', 'STDOUT' and 'STDERR'. Logically the path settings from above (C, ...) will be ignored in this case. DISCLAIMER: Using this argument may not detach your daemon fully from the parent! Use it at your own risk. =item dont_close_fd Same function and disclaimer as C, but instead of file handles you write the numeric file descriptors inside the arrayref. =item pid_file Defines the path to a file (owned by the parent user) where the PID of the daemon process will be stored. Defaults to C (= write no file). =item exec_command Scalar or arrayref with system command(s) that will be executed by the daemon via Perls C. In this case the child will never return to the parents process! =back Example: my $daemon = Proc::Daemon->new( work_dir => '/working/daemon/directory', child_STDOUT => '/path/to/daemon/output.file', child_STDERR => '+>>debug.txt', pid_file => 'pid.txt', exec_command => 'perl /home/my_script.pl', # or: # exec_command => [ 'perl /home/my_script.pl', 'perl /home/my_other_script.pl' ], ); In this example: =over 8 =item * the PID of the daemon will be returned to C<$daemon> in the parent process and a pid-file will be created at C. =item * STDOUT will be open with Mode '+>' (write/read) to C and STDERR will be open to C with Mode '+>>' (write/read opened for appending). =item * the script C will be executed by C and run as daemon. Therefore the child process will never return to this parent script. =back =back =head1 METHODS =over 4 =item Init( [ { %ARGS } ] ) Become a daemon. If used for the first time after C, you call C with the object reference to start the daemon. $pid = $daemon->Init(); If you want to use the object reference created by C for other daemons, you write C. %ARGS are the same as described in C. Notice that you shouldn't call C without argument in this case, or the next daemon will execute and/or write in the same files as the first daemon. To prevent this use at least an empty anonymous hash here. $pid = $daemon->Init( {} ); @pid = $daemon->Init( { work_dir => '/other/daemon/directory', exec_command => [ 'perl /home/my_second_script.pl', 'perl /home/my_third_script.pl' ], } ); If you don't need the Proc::Daemon object reference in your script, you can also use the method without object reference: $pid = Proc::Daemon::Init(); # or $pid = Proc::Daemon::Init( { %ARGS } ); C returns the PID (scalar) of the daemon to the parent, or the PIDs (array) of the daemons created if C has more then one program to execute. See examples above. C returns 0 to the child (daemon). If you call the C method in the context without looking for a return value (void context) the parent process will C here like in earlier versions: Proc::Daemon::Init(); =item Status( [ $ARG ] ) This function checks the status of the process (daemon). Returns the PID number (alive) or 0 (dead). $ARG can be a string with: =over 8 =item * C, in this case it tries to get the PID to check out of the object reference settings. =item * a PID number to check. =item * the path to a file containing the PID to check. =item * the command line entry of the running program to check. This requires L to be installed. =back =item Kill_Daemon( [ $ARG [, SIGNAL] ] ) This function kills the Daemon process. Returns the number of processes successfully killed (which mostly is not the same as the PID number), or 0 if the process wasn't found. $ARG is the same as of C. SIGNAL is an optional signal name or number as required by Perls C function and listed out by C on your system. Default value is 9 ('KILL' = non-catchable, non-ignorable kill). =item Fork Is like the Perl built-in C, but it retries to fork over 30 seconds if necessary and if possible to fork at all. It returns the child PID to the parent process and 0 to the child process. If the fork is unsuccessful it Cs and returns C. =back =head1 OTHER METHODS Proc::Daemon also defines some other functions. See source code for more details: =over 4 =item OpenMax( [ $NUMBER ] ) Returns the maximum file descriptor number. If undetermined $NUMBER will be returned. =item adjust_settings Does some fixes/adjustments on the C settings together with C. =item fix_filename( $KEYNAME ) Prevents double use of same filename in different processes. =item get_pid( [ $STRING ] ) Returns the wanted PID if it can be found. =item get_pid_by_proc_table_attr( $ATTR, $MATCH ) Returns the wanted PID by looking into the process table, or C. Requires the C module to be installed. =back =head1 NOTES C is still available for backwards capability. =head1 AUTHORS Primary-maintainer and code writer until version 0.03: =over 4 =item * Earl Hood, earl@earlhood.com, http://www.earlhood.com/ =back Co-maintainer and code writer since version 0.04: =over 4 =item * Detlef Pilzecker, http://search.cpan.org/~deti/, http://www.secure-sip-server.net/ =back =head1 CREDITS Initial implementation of C derived from the following sources: =over 4 =item * "Advanced Programming in the UNIX Environment" by W. Richard Stevens. Addison-Wesley, Copyright 1992. =item * "UNIX Network Programming", Vol 1, by W. Richard Stevens. Prentice-Hall PTR, Copyright 1998. =back =head1 PREREQUISITES This module requires the C module to be installed. The C module is not essentially required but it can be useful if it is installed (see above). =head1 SEE ALSO L, L, L =head1 COPYRIGHT This module is Copyright (C) 1997-2011 by Earl Hood and Detlef Pilzecker. All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself. Proc-Daemon-0.14/lib/Proc/Daemon.pm0000644000000000000000000006131211572110544015455 0ustar rootroot################################################################################ ## File: ## Daemon.pm ## Authors: ## Earl Hood earl@earlhood.com ## Detlef Pilzecker deti@cpan.org ## Description: ## Run Perl program(s) as a daemon process, see docu in the Daemon.pod file ################################################################################ ## Copyright (C) 1997-2011 by Earl Hood and Detlef Pilzecker. ## ## All rights reserved. ## ## This module is free software. It may be used, redistributed and/or modified ## under the same terms as Perl itself. ################################################################################ package Proc::Daemon; use strict; use POSIX(); $Proc::Daemon::VERSION = '0.14'; ################################################################################ # Create the Daemon object: # my $daemon = Proc::Daemon->new( [ %Daemon_Settings ] ) # # %Daemon_Settings are hash key=>values and can be: # work_dir => '/working/daemon/directory' -> defaults to '/' # setuid => 12345 -> defaults to # child_STDIN => '/path/to/daemon/STDIN.file' -> defautls to ' '/path/to/daemon/STDOUT.file' -> defaults to '+>/dev/null' # child_STDERR => '/path/to/daemon/STDERR.file' -> defaults to '+>/dev/null' # dont_close_fh => [ 'main::DATA', 'PackageName::DATA', 'STDOUT', ... ] # -> arrayref with file handles you do not want to be closed in the daemon. # dont_close_fd => [ 5, 8, ... ] -> arrayref with file # descriptors you do not want to be closed in the daemon. # pid_file => '/path/to/pid/file.txt' -> defaults to # undef (= write no file). # exec_command => 'perl /home/script.pl' -> execute a system command # via Perls *exec PROGRAM* at the end of the Init routine and never return. # Must be an arrayref if you want to create several daemons at once. # # Returns: the blessed object. ################################################################################ sub new { my ( $class, %args ) = @_; my $self = \%args; bless( $self, $class ); $self->{memory} = {}; return $self; } ################################################################################ # Become a daemon: # $daemon->Init # # or, for more daemons with other settings in the same script: # Use a hash as below. The argument must (!) now be a hashref: {...} # even if you don't modify the initial settings (=> use empty hashref). # $daemon->Init( { [ %Daemon_Settings ] } ) # # or, if no Daemon->new() object was created and for backward compatibility: # Proc::Daemon::Init( [ { %Daemon_Settings } ] ) # In this case the argument must be or a hashref! # # %Daemon_Settings see &new. # # Returns to the parent: # - nothing (parent does exit) if the context is looking for no return value. # - the PID(s) of the daemon(s) created. # Returns to the child (daemon): # its PID (= 0) | never returns if used with 'exec_command'. ################################################################################ sub Init { my Proc::Daemon $self = shift; my $settings_ref = shift; # Check if $self has been blessed into the package, otherwise do it now. unless ( ref( $self ) && eval{ $self->isa( 'Proc::Daemon' ) } ) { $self = ref( $self ) eq 'HASH' ? Proc::Daemon->new( %$self ) : Proc::Daemon->new(); } # If $daemon->Init is used again in the same script, # update to the new arguments. elsif ( ref( $settings_ref ) eq 'HASH' ) { map { $self->{ $_ } = $$settings_ref{ $_ } } keys %$settings_ref; } # Open a filehandle to an anonymous temporary pid file. If this is not # possible (some environments do not allow all users to use anonymous # temporary files), use the pid_file(s) to retrieve the PIDs for the parent. my $FH_MEMORY; unless ( open( $FH_MEMORY, "+>", undef ) || $self->{pid_file} ) { die "Can not anonymous temporary pidfile ('$!'), therefore you must add 'pid_file' as an Init() argument, e.g. to: '/tmp/proc_daemon_pids'"; } # Get the file descriptors the user does not want to close. my %dont_close_fd; if ( defined $self->{dont_close_fd} ) { die "The argument 'dont_close_fd' must be arrayref!" if ref( $self->{dont_close_fd} ) ne 'ARRAY'; foreach ( @{ $self->{dont_close_fd} } ) { die "All entries in 'dont_close_fd' must be numeric ('$_')!" if $_ =~ /\D/; $dont_close_fd{ $_ } = 1; } } # Get the file descriptors of the handles the user does not want to close. if ( defined $self->{dont_close_fh} ) { die "The argument 'dont_close_fh' must be arrayref!" if ref( $self->{dont_close_fh} ) ne 'ARRAY'; foreach ( @{ $self->{dont_close_fh} } ) { if ( defined ( my $fn = fileno $_ ) ) { $dont_close_fd{ $fn } = 1; } } } # If system commands are to be executed, put them in a list. my @exec_command = ref( $self->{exec_command} ) eq 'ARRAY' ? @{ $self->{exec_command} } : ( $self->{exec_command} ); $#exec_command = 0 if $#exec_command < 0; # Create a daemon for every system command. foreach my $exec_command ( @exec_command ) { # The first parent is running here. # Using this subroutine or loop multiple times we must modify the filenames: # 'child_STDIN', 'child_STDOUT', 'child_STDERR' and 'pid_file' for every # daemon (a higher number will be appended to the filenames). $self->adjust_settings(); # First fork. my $pid = Fork(); if ( defined $pid && $pid == 0 ) { # The first child runs here. # Set the new working directory. die "Can't to $self->{work_dir}: $!" unless chdir $self->{work_dir}; # Clear the file creation mask. umask 0; # Detach the child from the terminal (no controlling tty), make it the # session-leader and the process-group-leader of a new process group. die "Cannot detach from controlling terminal" if POSIX::setsid() < 0; # "Is ignoring SIGHUP necessary? # # It's often suggested that the SIGHUP signal should be ignored before # the second fork to avoid premature termination of the process. The # reason is that when the first child terminates, all processes, e.g. # the second child, in the orphaned group will be sent a SIGHUP. # # 'However, as part of the session management system, there are exactly # two cases where SIGHUP is sent on the death of a process: # # 1) When the process that dies is the session leader of a session that # is attached to a terminal device, SIGHUP is sent to all processes # in the foreground process group of that terminal device. # 2) When the death of a process causes a process group to become # orphaned, and one or more processes in the orphaned group are # stopped, then SIGHUP and SIGCONT are sent to all members of the # orphaned group.' [2] # # The first case can be ignored since the child is guaranteed not to have # a controlling terminal. The second case isn't so easy to dismiss. # The process group is orphaned when the first child terminates and # POSIX.1 requires that every STOPPED process in an orphaned process # group be sent a SIGHUP signal followed by a SIGCONT signal. Since the # second child is not STOPPED though, we can safely forego ignoring the # SIGHUP signal. In any case, there are no ill-effects if it is ignored." # Source: http://code.activestate.com/recipes/278731/ # # local $SIG{'HUP'} = 'IGNORE'; # Second fork. # This second fork is not absolutely necessary, it is more a precaution. # 1. Prevent possibility of reacquiring a controlling terminal. # Without this fork the daemon would remain a session-leader. In # this case there is a potential possibility that the process could # reacquire a controlling terminal. E.g. if it opens a terminal device, # without using the O_NOCTTY flag. In Perl this is normally the case # when you use on this kind of device, instead of # with the O_NOCTTY flag set. # Note: Because of the second fork the daemon will not be a session- # leader and therefore Signals will not be send to other members of # his process group. If you need the functionality of a session-leader # you may want to call POSIX::setsid() manually on your daemon. # 2. Detach the daemon completely from the parent. # The double-fork prevents the daemon from becoming a zombie. It is # needed in this module because the grandparent process can continue. # Without the second fork and if a child exits before the parent # and you forget to call in the parent you will get a zombie # until the parent also terminates. Using the second fork we can be # sure that the parent of the daemon is finished near by or before # the daemon exits. $pid = Fork(); if ( defined $pid && $pid == 0 ) { # Here the second child is running. # Close all file handles and descriptors the user does not want # to preserve. my $hc_fd; # highest closed file descriptor close $FH_MEMORY; foreach ( 0 .. OpenMax() ) { unless ( $dont_close_fd{ $_ } ) { if ( $_ == 0 ) { close STDIN } elsif ( $_ == 1 ) { close STDOUT } elsif ( $_ == 2 ) { close STDERR } else { $hc_fd = $_ if POSIX::close( $_ ) } } } # Sets the real user identifier and the effective user # identifier for the daemon process before opening files. POSIX::setuid( $self->{setuid} ) if defined $self->{setuid}; # Reopen STDIN, STDOUT and STDERR to 'child_STD...'-path or to # /dev/null. Data written on a null special file is discarded. # Reads from the null special file always return end of file. open( STDIN, $self->{child_STDIN} || "{child_STDOUT} || "+>/dev/null" ) unless $dont_close_fd{ 1 }; open( STDERR, $self->{child_STDERR} || "+>/dev/null" ) unless $dont_close_fd{ 2 }; # Since is in some cases "secretly" closing # file descriptors without telling it to perl, we need to # re and as many files as we closed with # . Otherwise it can happen (especially with # FH opened by __DATA__ or __END__) that there will be two perl # handles associated with one file, what can cause some # confusion. :-) # see: http://rt.perl.org/rt3/Ticket/Display.html?id=72526 if ( $hc_fd ) { my @fh; foreach ( 3 .. $hc_fd ) { open $fh[ $_ ], ", , or # following . The function executes a system # command and never returns. } # Return the childs own PID (= 0) return $pid; } # First child (= second parent) runs here. # Print the PID of the second child into ... $pid ||= ''; # ... the anonymous temporary pid file. if ( $FH_MEMORY ) { print $FH_MEMORY "$pid\n"; close $FH_MEMORY; } # ... the real 'pid_file'. if ( $self->{pid_file} ) { open( my $FH_PIDFILE, "+>", $self->{pid_file} ) || die "Can not open pidfile (pid_file => '$self->{pid_file}'): $!"; print $FH_PIDFILE $pid; close $FH_PIDFILE; } # Don't for the second child to exit, # even if we don't have a value in $exec_command. # The second child will become orphan by here, but then it # will be adopted by init(8), which automatically performs a # to remove the zombie when the child exits. exit; } # Only first parent runs here. # A child that terminates, but has not been waited for becomes # a zombie. So we wait for the first child to exit. waitpid( $pid, 0 ); } # Only first parent runs here. # Exit if the context is looking for no value (void context). exit 0 unless defined wantarray; # Get the daemon PIDs out of the anonymous temporary pid file # or out of the real pid-file(s) my @pid; if ( $FH_MEMORY ) { seek( $FH_MEMORY, 0, 0 ); @pid = map { chomp $_; $_ eq '' ? undef : $_ } <$FH_MEMORY>; close $FH_MEMORY; } elsif ( $self->{memory}{pid_file} ) { foreach ( keys %{ $self->{memory}{pid_file} } ) { open( $FH_MEMORY, "<", $_ ) || die "Can not open pid_file '<$_': $!"; push( @pid, <$FH_MEMORY> ); close $FH_MEMORY; } } # Return the daemon PIDs (from second child/ren) to the first parent. return ( wantarray ? @pid : $pid[0] ); } # For backward capability: *init = \&Init; ################################################################################ # Set some defaults and adjust some settings. # Args: ( $self ) # Returns: nothing ################################################################################ sub adjust_settings { my Proc::Daemon $self = shift; # Set default 'work_dir' if needed. $self->{work_dir} ||= '/'; $self->fix_filename( 'child_STDIN', 1 ) if $self->{child_STDIN}; $self->fix_filename( 'child_STDOUT', 1 ) if $self->{child_STDOUT}; $self->fix_filename( 'child_STDERR', 1 ) if $self->{child_STDERR}; # Check 'pid_file's name if ( $self->{pid_file} ) { die "Pidfile (pid_file => '$self->{pid_file}') can not be only a number. I must be able to distinguish it from a PID number in &get_pid('...')." if $self->{pid_file} =~ /^\d+$/; $self->fix_filename( 'pid_file' ); } return; } ################################################################################ # - If the keys value is only a filename add the path of 'work_dir'. # - If we have already set a file for this key with the same "path/name", # add a number to the file. # Args: ( $self, $key, $extract_mode ) # key: one of 'child_STDIN', 'child_STDOUT', 'child_STDERR', 'pid_file' # extract_mode: true = separate MODE form filename before checking # path/filename; false = no MODE to check # Returns: nothing ################################################################################ sub fix_filename { my Proc::Daemon $self = shift; my $key = shift; my $var = $self->{ $key }; my $mode = ( shift ) ? ( $var =~ s/^([\+\<\>\-\|]+)// ? $1 : ( $key eq 'child_STDIN' ? '<' : '+>' ) ) : ''; # add path to filename if ( $var =~ s/^\.\/// || $var !~ /\// ) { $var = $self->{work_dir} =~ /\/$/ ? $self->{work_dir} . $var : $self->{work_dir} . '/' . $var; } # If the file was already in use, modify it with '_number': # filename_X | filename_X.ext if ( $self->{memory}{ $key }{ $var } ) { $var =~ s/([^\/]+)$//; my @i = split( /\./, $1 ); my $j = $#i ? $#i - 1 : 0; $self->{memory}{ "$key\_num" } ||= 0; $i[ $j ] =~ s/_$self->{memory}{ "$key\_num" }$//; $self->{memory}{ "$key\_num" }++; $i[ $j ] .= '_' . $self->{memory}{ "$key\_num" }; $var .= join( '.', @i ); } $self->{memory}{ $key }{ $var } = 1; $self->{ $key } = $mode . $var; return; } ################################################################################ # Fork(): Retries to fork over 30 seconds if possible to fork at all and # if necessary. # Returns the child PID to the parent process and 0 to the child process. # If the fork is unsuccessful it Cs and returns C. ################################################################################ sub Fork { my $pid; my $loop = 0; FORK: { if ( defined( $pid = fork ) ) { return $pid; } # EAGAIN - fork cannot allocate sufficient memory to copy the parent's # page tables and allocate a task structure for the child. # ENOMEM - fork failed to allocate the necessary kernel structures # because memory is tight. # Last the loop after 30 seconds if ( $loop < 6 && ( $! == POSIX::EAGAIN() || $! == POSIX::ENOMEM() ) ) { $loop++; sleep 5; redo FORK; } } warn "Can't fork: $!"; return undef; } ################################################################################ # OpenMax( [ NUMBER ] ) # Returns the maximum number of possible file descriptors. If sysconf() # does not give me a valid value, I return NUMBER (default is 64). ################################################################################ sub OpenMax { my $openmax = POSIX::sysconf( &POSIX::_SC_OPEN_MAX ); return ( ! defined( $openmax ) || $openmax < 0 ) ? ( shift || 64 ) : $openmax; } ################################################################################ # Check if the (daemon) process is alive: # Status( [ number or string ] ) # # Examples: # $object->Status() - Tries to get the PID out of the settings in new() and checks it. # $object->Status( 12345 ) - Number of PID to check. # $object->Status( './pid.txt' ) - Path to file containing one PID to check. # $object->Status( 'perl /home/my_perl_daemon.pl' ) - Command line entry of the # running program to check. Requires Proc::ProcessTable to work. # # Returns the PID (alive) or 0 (dead). ################################################################################ sub Status { my Proc::Daemon $self = shift; my $pid = shift; # Get the process ID. ( $pid, undef ) = $self->get_pid( $pid ); # Return if no PID was found. return 0 if ! $pid; # The kill(2) system call will check whether it's possible to send # a signal to the pid (that means, to be brief, that the process # is owned by the same user, or we are the super-user). This is a # useful way to check that a child process is alive (even if only # as a zombie) and hasn't changed its UID. return ( kill( 0, $pid ) ? $pid : 0 ); } ################################################################################ # Kill the (daemon) process: # Kill_Daemon( [ number or string [, SIGNAL ] ] ) # # Examples: # $object->Kill_Daemon() - Tries to get the PID out of the settings in new() and kill it. # $object->Kill_Daemon( 12345, 'TERM' ) - Number of PID to kill with signal 'TERM'. The # names or numbers of the signals are the ones listed out by kill -l on your system. # $object->Kill_Daemon( './pid.txt' ) - Path to file containing one PID to kill. # $object->Kill_Daemon( 'perl /home/my_perl_daemon.pl' ) - Command line entry of the # running program to kill. Requires Proc::ProcessTable to work. # # Returns the number of processes successfully killed, # which mostly is not the same as the PID number. ################################################################################ sub Kill_Daemon { my Proc::Daemon $self = shift; my $pid = shift; my $signal = shift || 'KILL'; my $pidfile; # Get the process ID. ( $pid, $pidfile ) = $self->get_pid( $pid ); # Return if no PID was found. return 0 if ! $pid; # Kill the process. my $killed = kill( $signal, $pid ); if ( $killed && $pidfile ) { # Set PID in pid file to '0'. if ( open( my $FH_PIDFILE, "+>", $pidfile ) ) { print $FH_PIDFILE '0'; close $FH_PIDFILE; } else { warn "Can not open pidfile (pid_file => '$pidfile'): $!" } } return $killed; } ################################################################################ # Return the PID of a process: # get_pid( number or string ) # # Examples: # $object->get_pid() - Tries to get the PID out of the settings in new(). # $object->get_pid( 12345 ) - Number of PID to return. # $object->get_pid( './pid.txt' ) - Path to file containing the PID. # $object->get_pid( 'perl /home/my_perl_daemon.pl' ) - Command line entry of # the running program. Requires Proc::ProcessTable to work. # # Returns an array with ( 'the PID | ', 'the pid_file | ' ) ################################################################################ sub get_pid { my Proc::Daemon $self = shift; my $string = shift || ''; my ( $pid, $pidfile ); if ( $string ) { # $string is already a PID. if ( $string =~ /^\d+$/ ) { $pid = $string; } # Open the pidfile and get the PID from it. elsif ( open( my $FH_MEMORY, "<", $string ) ) { $pid = <$FH_MEMORY>; close $FH_MEMORY; die "I found no valid PID ('$pid') in the pidfile: '$string'" if $pid =~ /\D/s; $pidfile = $string; } # Get the PID by the system process table. else { $pid = $self->get_pid_by_proc_table_attr( 'cmndline', $string ); } } # Try to get the PID out of the new() settings. if ( ! $pid ) { # Try to get the PID out of the 'pid_file' setting. if ( $self->{pid_file} && open( my $FH_MEMORY, "<", $self->{pid_file} ) ) { $pid = <$FH_MEMORY>; close $FH_MEMORY; if ( ! $pid || ( $pid && $pid =~ /\D/s ) ) { $pid = undef } else { $pidfile = $self->{pid_file} } } # Try to get the PID out of the system process # table by the 'exec_command' setting. if ( ! $pid && $self->{exec_command} ) { $pid = $self->get_pid_by_proc_table_attr( 'cmndline', $self->{exec_command} ); } } return ( $pid, $pidfile ); } ################################################################################ # This sub requires the Proc::ProcessTable module to be installed!!! # # Search for the PID of a process in the process table: # $object->get_pid_by_proc_table_attr( 'unix_process_table_attribute', 'string that must match' ) # # unix_process_table_attribute examples: # For more see the README.... files at http://search.cpan.org/~durist/Proc-ProcessTable/ # uid - UID of process # pid - process ID # ppid - parent process ID # fname - file name # state - state of process # cmndline - full command line of process # cwd - current directory of process # # Example: # get_pid_by_proc_table_attr( 'cmndline', 'perl /home/my_perl_daemon.pl' ) # # Returns the process PID on success, otherwise . ################################################################################ sub get_pid_by_proc_table_attr { my Proc::Daemon $self = shift; my ( $command, $match ) = @_; my $pid; # eval - Module may not be installed eval { require Proc::ProcessTable; my $table = Proc::ProcessTable->new()->table; foreach ( @$table ) { # fix for Proc::ProcessTable: under some conditions $_->cmndline # retruns with space and/or other characters at the end next unless $_->$command =~ /^$match\s*$/; $pid = $_->pid; last; } }; warn "- Problem in get_pid_by_proc_table_attr( '$command', '$match' ):\n $@ You may not use a command line entry to get the PID of your process.\n This function requires Proc::ProcessTable (http://search.cpan.org/~durist/Proc-ProcessTable/) to work.\n" if $@; return $pid; } 1;Proc-Daemon-0.14/t/0000755000000000000000000000000011572120440012477 5ustar rootrootProc-Daemon-0.14/t/02_testmodule.t0000644000000000000000000001077411515514024015365 0ustar rootroot#!/usr/bin/perl use strict; use warnings; use Test::More tests => 16; use Cwd; use Proc::Daemon; # Since a daemon will not be able to print terminal output, we # have a test daemon creating a file and another which runs the created # Perl file. # The parent process will test for the existence of the created files # and for the running daemon. # Try to make sure we are in the test directory my $cwd = Cwd::cwd(); chdir 't' if $cwd !~ m{/t$}; $cwd = Cwd::cwd(); # create object my $daemon = Proc::Daemon->new( work_dir => $cwd, child_STDOUT => 'output.file', child_STDERR => 'error.file', pid_file => 'pid.file', ); # create a daemon my $Kid_PID = $daemon->init; # init instead of Init is a test for the old style too! if ( ok( $Kid_PID, "child_1 was created with PID: " . ( defined $Kid_PID ? $Kid_PID : '' ) ) || defined $Kid_PID ) { # here goes the child unless ( $Kid_PID ) { # print something into 'output.file' print 'test1'; # print a new Perl file open( FILE, ">$cwd/kid.pl" ) || die; print FILE "#!/usr/bin/perl # stay alive vor 10 sec. foreach ( 1 .. 10 ) { sleep ( 1 ) } exit;"; close( FILE ); } # this is only for the parent else { # wait max. 5 sec. for the child to exit my $r = 0; while ( $daemon->Status( $Kid_PID ) and $r <= 5 ) { $r++; sleep( 1 ); } if ( ok( ! $daemon->Status( $Kid_PID ), "child_1 process did exit within $r sec." ) ) { if ( ok( -e "$cwd/pid.file", "child_1 has created a 'pid.file'" ) ) { my ( $pid, undef ) = $daemon->get_pid( "$cwd/pid.file" ); ok( $pid == $Kid_PID, "the 'pid.file' contains the right PID: $pid" ); unlink "$cwd/pid.file"; } if ( ok( -e "$cwd/output.file", "child_1 has created a 'output.file'" ) ) { open( FILE, "<", "$cwd/output.file" ); ok( eq 'test1', "the content of the 'output.file' was right." ); close FILE; unlink "$cwd/output.file"; } if ( ok( -e "$cwd/error.file", "child_1 has created a 'error.file'" ) ) { unlink "$cwd/error.file"; } if ( ok( -e "$cwd/kid.pl", "child_1 has created the 'kid.pl' file" ) ) { my $Kid_PID2 = $daemon->Init( { exec_command => "perl $cwd/kid.pl", } ); if ( ok( $Kid_PID2, "child_2 was created with PID: " . ( defined $Kid_PID2 ? $Kid_PID2 : '' ) ) ) { if ( ok( -e "$cwd/pid_1.file", "child_2 created a 'pid_1.file'" ) ) { my ( $pid, undef ) = $daemon->get_pid( "$cwd/pid_1.file" ); ok( $pid == $Kid_PID2, "the 'pid_1.file' contains the right PID: $pid" ) } # wait max. 5 sec. for the (second) child to write all files $r = 0; while ( ! -e "$cwd/error_1.file" and $r <= 5 ) { $r++; sleep( 1 ); } if ( ok( -e "$cwd/output_1.file", "child_2 created a 'output_1.file'" ) ) { unlink "$cwd/output_1.file"; } if ( ok( -e "$cwd/error_1.file", "child_2 created a 'error_1.file'" ) ) { unlink "$cwd/error_1.file"; } sleep( 3 ); diag( 'Parent slept for 3 sec.' ); my $pid = $daemon->get_pid_by_proc_table_attr( 'cmndline', "perl $cwd/kid.pl", 1 ); diag( "Proc::ProcessTable is installed and did find the right PID for 'perl $cwd/kid.pl': $pid" ) if defined $pid and $pid == $Kid_PID2; $pid = $daemon->Status( "$cwd/pid_1.file" ); ok( $pid == $Kid_PID2, "'kid.pl' daemon is still running" ); my $stopped = $daemon->Kill_Daemon(); ok( $stopped == 1, "stop daemon 'kid.pl'" ); $r = 0; while ( $pid = $daemon->Status( $Kid_PID2 ) and $r <= 10 ) { $r++; sleep( 1 ); } ok( $pid != $Kid_PID2, "'kid.pl' daemon was stopped within $r sec." ); unlink "$cwd/pid_1.file"; } unlink "$cwd/kid.pl"; } } } } Proc-Daemon-0.14/t/01_loadmodule.t0000644000000000000000000000025311460037034015313 0ustar rootroot#!/usr/bin/perl use strict; use warnings; use Test::More tests => 1; eval <<'EVAL'; use Proc::Daemon; EVAL cmp_ok( $@, 'eq', '', 'loading Proc::Daemon' ); Proc-Daemon-0.14/Changes0000644000000000000000000000704111572107622013540 0ustar rootrootRevision history for Perl module Proc::Daemon. 0.14 Fri Jun 03 2011 - The filename memory is now a part of the object (not a package variable any more). This was a bug. - Since is not performed on Windows OS as on Linux, I removed the and from 0.13 and add an INFO to the documentation. - Updated the documentation. 0.13 Wed Jun 01 2011 - Add ability to define the user identifier for the daemon if you want to run it under other user then the parent (request from Holger Gläss). - Add and for OS not supporting POSIX::setsid (e.g. Windows). - Updated the documentation. 0.12 Tue Mai 24 2011 - Init() did not close all filehandles reliably in some cases. Thanks again to Rob Brown for reporting. - Text improvement in the documentation. 0.11 Mon Mai 23 2011 - Init() didn't close all filehandles reliably (see also bug report at http://rt.perl.org/rt3/Ticket/Display.html?id=72526). Thanks to Rob Brown for reporting and offering a patch. - Attributes 'dont_close_fh' AND 'dont_close_fd' added so we can define file handles and descriptors that must be preserved from the parent into the child (daemon). - Updated the documentation. - In some environment it is not allowed to open anonymous files. In this case now a 'pid_file' must be defined. Thanks to Holger Gläss for reporting. 0.10 Fri Apr 01 2011 - Improvement how Init() determines whether it was passed a blessed object 0.09 Tue Mar 15 2011 - Fix for a possibly not reseted numbered match variable ($1). - Typo fix and text improvement in the documentation. 0.08 Sun Mar 13 2011 - The Mode of the daemon file handles STDIN, STDOUT, STDERR can be specified now. The default Mode values are the same as before. - Updated the documentation. 0.07 Thu Feb 17 2011 - Add signal processing to Kill_Daemon(). - Updated the documentation. 0.06 Mon Jan 17 2011 - A lot of documentation was add to the source code. - Daemon STDIN was fixed to "read" now instead of "write". - Replaced global filehandles with scalars. - Add a if fails. - Updated the documentation and add a note to the documentation about the behavior of process-group Signals. 0.05 Thu Okt 28 2010 - Fixed a problem when using the old method of calling Proc::Daemon::Init without object (reported by Alex Samorukov). The parent process didn't exit. - Fixed a problem with Proc::ProcessTable 0.44: Under some conditions 'cmndline' retruns with space and/or other characters at the end. - Update and small fixes in the documentation. 0.04 Sun Okt 24 2010 - Added functions: new(), adjust_settings(), fix_filename(), Status(), Kill_Daemon(), get_pid() and get_pid_by_proc_table_attr(). - Init() now returns the PID of the daemon. - Fork() now allways returns values like Perls built-in 'fork' does. - Description was rewritten, extended and moved to the new Daemon.pod file. - Additional test are done at installation. - $SIG{'HUP'} was set to be valid only 'local' (bug report). - POSIX::EAGAIN() was added to Fork() (bug report). 0.03 Thu Jun 19 2003 - Licensing is more explicit: Either GPL or Artistic. - Updated author contact information. 0.02 Sat Apr 17 1999 - init() function superceded by Init() function. - All open files are closed during daemonization. - A double fork is now down to avoid the potential of acquiring a controlling terminal. - Added Fork() and OpenMax() functions. 0.01 Thu Jan 27 1998 - Initial bundled release. Proc-Daemon-0.14/README0000644000000000000000000000245211515067060013124 0ustar rootrootREADME for Proc::Daemon --------------------------------------------------------------------------- SUMMARY Proc::Daemon provides the capability for a Perl program to run as a Unix daemon process. --------------------------------------------------------------------------- INSTALLATION This module can be installed on Perl 5.8. It was not tested on older versions but it might work. You should be able to install the module with the following: perl Makefile.PL make make test make install If you want to install in a specific directory, try: perl Makefile.PL PREFIX=/tmp/myperl5 ... If you'd like to see the raw output of the tests, try: ... make test TEST_VERBOSE=1 ... --------------------------------------------------------------------------- DOCUMENTATION Documentation is in the Daemon.pod file and should automatically get installed with the module. --------------------------------------------------------------------------- COPYRIGHT (C) 1997-2011 Earl Hood earl@earlhood.com http://www.earlhood.com/ and Detlef Pilzecker deti@cpan.org http://www.secure-sip-server.net/ All rights reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself. Proc-Daemon-0.14/Makefile.PL0000644000000000000000000000037511460544466014231 0ustar rootrootuse ExtUtils::MakeMaker; require 5.008; WriteMakefile( NAME => 'Proc::Daemon', AUTHOR => 'Earl Hood earl@earlhood.com, Detlef Pilzecker deti@cpan.org', VERSION_FROM => 'lib/Proc/Daemon.pm', PREREQ_PM => { 'POSIX' => 0, }, LICENSE => 'perl', );Proc-Daemon-0.14/META.yml0000644000000000000000000000067111572120440013511 0ustar rootroot--- #YAML:1.0 name: Proc-Daemon version: 0.14 abstract: ~ license: perl author: - Earl Hood earl@earlhood.com, Detlef Pilzecker deti@cpan.org generated_by: ExtUtils::MakeMaker version 6.42 distribution_type: module requires: POSIX: 0 meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.3.html version: 1.3