Proc-Daemon-0.23000755001750001750 012641545112 11714 5ustar00akak000000000000Changes100644001750001750 1077212641545112 13317 0ustar00akak000000000000Proc-Daemon-0.23Revision history for Perl module Proc::Daemon. 0.23 Fri Jan 1 2016 - RT#110330: fix taint safe test (Owen Boyle). 0.22 Wed Oct 28 2015 - RT#108012: force all tests to be executed sequentially (Alceu Rodrigues de Freitas Junior). 0.21 Thu Aug 6 2015 - GH#5: make tests less time-sensitive (Stefan Parvu). - RT#103130: fix taint safe test (Håkon Hægland). 0.20 Wed Jun 24 2015 - GH#4: fix taint safe test (rouzier). - RT#103130: make tests less time-sensitive (Remi Collet, ppisar). 0.19 Sat Mar 21 2015 - RT#102360: add file_umask option (Cyrille Mastchenko). 0.18 Mon Jan 26 2015 - GH#2: make Proc::Daemon internally taint safe (Rob Van Dam). - GH#3: add option to setgid, same as setuid (Rob Van Dam). 0.17 Fri Jan 23 2015 - Move umask test to the end, should fix some failures from CPAN Testers. - RT#73352: replace exit with POSIX::_exit(0) in the "first child". 0.16 Thu Jan 22 2015 - GH#1: fix Proc::ProcessTable test requirement. - RT#72107: die when exec_command fails. 0.15 Wed Jan 21 2015 - RT#91450: fix pid file permissions. - RT#88512: fix typos in the documentation. 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. LICENSE100644001750001750 4366012641545112 13033 0ustar00akak000000000000Proc-Daemon-0.23This software is copyright (c) 2016 by Pavel Denisov. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2016 by Pavel Denisov. This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2016 by Pavel Denisov. This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End META.yml100644001750001750 121012641545112 13240 0ustar00akak000000000000Proc-Daemon-0.23--- abstract: 'Run Perl program(s) as a daemon process' author: - 'Earl Hood ' - 'Detlef Pilzecker ' - 'Pavel Denisov ' build_requires: Proc::ProcessTable: '0' configure_requires: ExtUtils::MakeMaker: '6.30' dynamic_config: 0 generated_by: 'Dist::Zilla version 5.015, CPAN::Meta::Converter version 2.150001' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Proc-Daemon requires: POSIX: '0' resources: homepage: https://github.com/akreal/Proc-Daemon repository: https://github.com/akreal/Proc-Daemon.git version: '0.23' MANIFEST100644001750001750 36512641545112 13112 0ustar00akak000000000000Proc-Daemon-0.23# This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.015. Changes LICENSE MANIFEST META.yml Makefile.PL README.md lib/Proc/Daemon.pm lib/Proc/Daemon.pod t/01_loadmodule.t t/02_testmodule.t t/03_taintmode.t t/testrules.yml README.md100644001750001750 106112641545112 13252 0ustar00akak000000000000Proc-Daemon-0.23# Summary Proc::Daemon provides the capability for a Perl program to run as a Unix daemon process. # Documentation Documentation is in the Daemon.pod file and should automatically get installed with the module. # Copyright and license COPYRIGHT (C) 1997-2015 Earl Hood earl@earlhood.com http://www.earlhood.com/ and Detlef Pilzecker deti@cpan.org http://www.secure-sip-server.net/ and Pavel Denisov akreal@cpan.org All rights reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself. Makefile.PL100644001750001750 215212641545112 13747 0ustar00akak000000000000Proc-Daemon-0.23 # This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.015. use strict; use warnings; use ExtUtils::MakeMaker 6.30; my %WriteMakefileArgs = ( "ABSTRACT" => "Run Perl program(s) as a daemon process", "AUTHOR" => "Earl Hood , Detlef Pilzecker , Pavel Denisov ", "BUILD_REQUIRES" => {}, "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => "6.30" }, "DISTNAME" => "Proc-Daemon", "EXE_FILES" => [], "LICENSE" => "perl", "NAME" => "Proc::Daemon", "PREREQ_PM" => { "POSIX" => 0 }, "TEST_REQUIRES" => { "Proc::ProcessTable" => 0 }, "VERSION" => "0.23", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "POSIX" => 0, "Proc::ProcessTable" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); t000755001750001750 012641545112 12100 5ustar00akak000000000000Proc-Daemon-0.23testrules.yml100644001750001750 1512641545112 14751 0ustar00akak000000000000Proc-Daemon-0.23/tseq: 't/*.t' 03_taintmode.t100644001750001750 44412641545112 14675 0ustar00akak000000000000Proc-Daemon-0.23/t#!/usr/bin/perl -T use strict; use warnings; use Cwd; # Try to make sure we are in the test directory my $cwd = Cwd::cwd(); chdir 't' if $cwd !~ m{/t$}; $cwd = Cwd::cwd(); $cwd = ($cwd =~ /^(.*)$/)[0]; # untaint # re-run 02_testmodule.t with taint mode on require "$cwd/02_testmodule.t"; 01_loadmodule.t100644001750001750 23712641545112 15034 0ustar00akak000000000000Proc-Daemon-0.23/t#!/usr/bin/perl use strict; use warnings; use Test::More tests => 1; eval <<'EVAL'; use Proc::Daemon; EVAL cmp_ok( $@, 'eq', '', 'loading Proc::Daemon' ); 02_testmodule.t100644001750001750 1423712641545112 15142 0ustar00akak000000000000Proc-Daemon-0.23/t#!/usr/bin/perl use strict; use warnings; use Test::More tests => 19; use Cwd; use Proc::Daemon; if (${^TAINT}) { # blindly untaint PATH (since there's no way we can know what is safe) # hopefully anyone using Proc::Daemon in taint mode will set PATH more carefully # update: let's try to remove things known (reported) to be unsafe $ENV{'PATH'} = join ':', grep { $_ ne '.' && defined && -d && ((stat $_)[2] & 07777) < 494 } $ENV{'PATH'} =~ /([^:]+)/g; delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'}; } # 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(); $cwd = ($cwd =~ /^(.*)$/)[0]; # untaint (needed for 03_taintmode) # 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 umask 022; 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 # create an empty file to test umask open FILE, '>$cwd/umask.file'; close FILE; # stay alive forever while ( 1 ) { sleep ( 1 ) } exit;"; close( FILE ); } # this is only for the parent else { # wait max. 1 min. for the child to exit my $r = 0; while ( $daemon->Status( $Kid_PID ) and $r <= 60 ) { $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" ); ok( (stat("$cwd/pid.file"))[2] == 33152, "the 'pid.file' has right permissions" ); 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", # this is essentially a noop but gives us better test coverage setgid => (split / /, $))[0], setuid => $>, } ); if ( ok( $Kid_PID2, "child_2 was created with PID: " . ( defined $Kid_PID2 ? $Kid_PID2 : '' ) ) ) { wait_for_file("$cwd/pid_1.file"); 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_for_file("$cwd/output_1.file"); ok( -e "$cwd/output_1.file", "child_2 created a 'output_1.file'" ); wait_for_file("$cwd/error_1.file"); ok( -e "$cwd/error_1.file", "child_2 created a 'error_1.file'" ); 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" ); if (! ok( $pid == $Kid_PID2, "'kid.pl' daemon is still running" )) { diag("$pid != $Kid_PID2"); diag("STDOUT:\n" . `cat $cwd/output_1.file`); diag("STDERR:\n" . `cat $cwd/error_1.file`); diag("$cwd:\n" . `ls -lt $cwd`); } wait_for_file("$cwd/umask.file"); my $stopped = $daemon->Kill_Daemon(); ok( $stopped == 1, "stop daemon 'kid.pl'" ); $r = 0; while ( $pid = $daemon->Status( $Kid_PID2 ) and $r <= 60 ) { $r++; sleep( 1 ); } ok( $pid != $Kid_PID2, "'kid.pl' daemon was stopped within $r sec." ); unlink "$cwd/pid_1.file"; unlink "$cwd/error_1.file"; unlink "$cwd/output_1.file"; ok( (stat("$cwd/umask.file"))[2] == 33188, "the 'umask.file' has right permissions" ); unlink "$cwd/umask.file"; } unlink "$cwd/kid.pl"; } } } } my $daemon2 = Proc::Daemon->new( work_dir => $cwd, child_STDOUT => 'output2.file', child_STDERR => 'error2.file', pid_file => 'pid2.file', file_umask => 022, ); my $Kid_PID2 = $daemon2->Init; if ( $Kid_PID2 ) { # wait max. 1 min. for the child to exit my $r = 0; while ( $daemon2->Status( $Kid_PID2 ) and $r <= 60 ) { $r++; sleep( 1 ); } ok( (stat("$cwd/pid2.file"))[2] == 33188, "the 'pid2.file' has right permissions via file_umask" ); unlink "$cwd/output2.file", "$cwd/error2.file", "$cwd/pid2.file"; } sub wait_for_file { my $file = shift; my $r = 0; while ( ! -e $file and $r <= 60 ) { $r++; sleep( 1 ); } } 1; Proc000755001750001750 012641545112 13306 5ustar00akak000000000000Proc-Daemon-0.23/libDaemon.pm100644001750001750 6323412641545112 15237 0ustar00akak000000000000Proc-Daemon-0.23/lib/Proc################################################################################ ## File: ## Daemon.pm ## Authors: ## Earl Hood earl@earlhood.com ## Detlef Pilzecker deti@cpan.org ## Pavel Denisov akreal@cpan.org ## Description: ## Run Perl program(s) as a daemon process, see docs in the Daemon.pod file ################################################################################ ## Copyright (C) 1997-2015 by Earl Hood, Detlef Pilzecker and Pavel Denisov. ## ## 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.23'; ################################################################################ # 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 '/' # setgid => 12345 -> 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). # file_umask => 022 -> defaults to 066 # 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}; # Set the file creation mask. $self->{_orig_umask} = umask; umask($self->{file_umask}); # 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 group identifier and the effective group # identifier for the daemon process before opening files. # Must set group first because you cannot change group # once you have changed user POSIX::setgid( $self->{setgid} ) if defined $self->{setgid}; # 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[ $_ ], "{_orig_umask}; # Execute a system command and never return. if ( $exec_command ) { exec ($exec_command) or die "couldn't exec $exec_command: $!"; exit; # Not a real exit, but needed since Perl warns you if # there is no statement like , , 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. POSIX::_exit(0); } # 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>; $_ = (/^(\d+)$/)[0] foreach @pid; # untaint 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' ); } $self->{file_umask} ||= 066; 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 = $1; # untaint } # 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; $pid = ($pid =~ /^(\d+)$/)[0]; # untaint $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 =~ /^(\d+)$/) { $pid = $1; # untaint $pidfile = $self->{pid_file}; } else { $pid = undef; } } # 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 # returns 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; Daemon.pod100644001750001750 2672412641545112 15410 0ustar00akak000000000000Proc-Daemon-0.23/lib/Proc =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 than 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 setgid Sets the real group identifier (C<$(>) and the effective group identifier (C<$)>) for the daemon process using C, just like C. As with C, the first user must have the rights to switch to the new group, otherwise the group id will not be changed. =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 file_umask Defines umask for C, C, C and C files. Defaults to C<066> (other users may not modify or read the files). =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. Proc::Daemon is now taint safe (assuming it is not passed any tainted parameters). =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 until version 0.14: =over 4 =item * Detlef Pilzecker, http://search.cpan.org/~deti/, http://www.secure-sip-server.net/ =back Co-maintainer and code writer since version 0.15: =over 4 =item * Pavel Denisov, http://search.cpan.org/~akreal/ =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 REPOSITORY L =head1 SEE ALSO L, L, L =head1 COPYRIGHT This module is Copyright (C) 1997-2015 by Earl Hood, Detlef Pilzecker and Pavel Denisov. All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.