1 package MooseX::Daemonize;
2 use strict; # because Kwalitee is pedantic
4 use MooseX::Types::Path::Class;
8 with 'MooseX::Daemonize::WithPidFile',
15 metaclass => 'Getopt',
21 ( my $name = lc $_[0]->meta->name ) =~ s/::/_/g;
27 metaclass => 'Getopt',
28 isa => 'Path::Class::Dir',
33 default => sub { Path::Class::Dir->new('', 'var', 'run') },
37 metaclass => 'Getopt',
38 isa => 'Path::Class::Dir',
43 default => sub { Path::Class::Dir->new('/') },
47 metaclass => 'Getopt',
55 metaclass => 'Getopt',
61 # internal book-keeping
63 has status_message => (
64 metaclass => 'NoGetopt',
67 clearer => 'clear_status_message',
71 metaclass => 'NoGetopt',
74 clearer => 'clear_exit_code',
79 ## PID file related stuff ...
83 my $file = $self->pidbase . '/' . $self->progname . '.pid';
84 confess "Cannot write to $file" unless (-e $file ? -w $file : -w $self->pidbase);
85 MooseX::Daemonize::Pid::File->new( file => $file );
89 sub check { (shift)->pidfile->is_running }
90 sub save_pid { (shift)->pidfile->write }
91 sub remove_pid { (shift)->pidfile->remove }
92 sub get_pid { (shift)->pidfile->pid }
94 ## signal handling ...
98 $SIG{'INT'} = sub { $self->shutdown };
99 # I can't think of a sane default here really ...
100 # $SIG{'HUP'} = sub { $self->handle_sighup };
105 $self->pidfile->remove if $self->pidfile->pid == $$;
109 ## daemon control methods ...
114 $self->clear_status_message;
115 $self->clear_exit_code;
117 if ($self->pidfile->is_running) {
118 $self->exit_code($self->OK);
119 $self->status_message('Daemon is already running with pid (' . $self->pidfile->pid . ')');
120 return !($self->exit_code);
123 if ($self->foreground) {
127 eval { $self->daemonize };
129 $self->exit_code($self->ERROR);
130 $self->status_message('Start failed : ' . $@);
131 return !($self->exit_code);
135 unless ($self->is_daemon) {
136 $self->exit_code($self->OK);
137 $self->status_message('Start succeeded');
138 return !($self->exit_code);
141 $self->pidfile->pid($$);
144 chdir $self->basedir;
146 $self->pidfile->write;
147 $self->setup_signals;
154 $self->clear_status_message;
155 $self->clear_exit_code;
157 if ($self->pidfile->is_running) {
158 $self->exit_code($self->OK);
159 $self->status_message('Daemon is running with pid (' . $self->pidfile->pid . ')');
162 $self->exit_code($self->ERROR);
163 $self->status_message('Daemon is not running with pid (' . $self->pidfile->pid . ')');
166 return !($self->exit_code);
172 $self->clear_status_message;
173 $self->clear_exit_code;
175 unless ($self->stop) {
176 $self->exit_code($self->ERROR);
177 $self->status_message('Restart (Stop) failed : ' . $@);
180 unless ($self->start) {
181 $self->exit_code($self->ERROR);
182 $self->status_message('Restart (Start) failed : ' . $@);
185 if ($self->exit_code == $self->OK) {
186 $self->exit_code($self->OK);
187 $self->status_message("Restart successful");
190 return !($self->exit_code);
193 # Make _kill *really* private
199 $self->clear_status_message;
200 $self->clear_exit_code;
202 # if the pid is not running
203 # then we dont need to stop
205 if ($self->pidfile->is_running) {
207 # if we are foreground, then
208 # no need to try and kill
210 unless ($self->foreground) {
212 # kill the process ...
213 eval { $self->$_kill($self->pidfile->pid) };
214 # and complain if we can't ...
216 $self->exit_code($self->ERROR);
217 $self->status_message('Stop failed : ' . $@);
219 # or gloat if we succeed ..
221 $self->exit_code($self->OK);
222 $self->status_message('Stop succeeded');
228 # this just returns the OK
229 # exit code for now, but
230 # we should make this overridable
231 $self->exit_code($self->OK);
232 $self->status_message("Not running");
235 # if we are returning to our script
236 # then we actually need the opposite
237 # of what the system/OS expects
238 return !($self->exit_code);
242 my ( $self, $pid ) = @_;
244 unless ( CORE::kill 0 => $pid ) {
245 # warn "$pid already appears dead.";
250 die "$pid is us! Can't commit suicide.";
253 my $timeout = $self->stop_timeout;
255 # kill 0 => $pid returns 0 if the process is dead
256 # $!{EPERM} could also be true if we cant kill it (permission error)
258 # Try SIGINT ... 2s ... SIGTERM ... 2s ... SIGKILL ... 3s ... UNDEAD!
259 my $terminating_signal;
260 for ( [ 'INT', $timeout ], ['TERM', $timeout], ['KILL', $timeout * 1.5] ) {
261 my ($signal, $timeout) = @$_;
262 $timeout = int $timeout;
264 CORE::kill($signal, $pid);
267 unless(CORE::kill 0 => $pid or $!{EPERM}) {
268 $terminating_signal = $signal;
272 sleep(1) if $timeout;
275 last if $terminating_signal;
278 if($terminating_signal) {
279 if($terminating_signal eq 'KILL') {
280 # clean up the pidfile ourselves iff we used KILL and it worked
281 warn "Had to resort to 'kill -KILL' and it worked, wiping pidfile";
282 eval { $self->pidfile->remove };
284 warn "Could not remove pidfile ("
285 . $self->pidfile->file
292 # IF it is still running
293 Carp::carp "$pid doesn't seem to want to die."; # AHH EVIL DEAD!
303 MooseX::Daemonize - Role for daemonizing your Moose based application
307 This document describes MooseX::Daemonize version 0.05
314 with qw(MooseX::Daemonize);
316 # ... define your class ....
320 return unless $self->is_daemon;
321 # your daemon code here ...
324 # then in your script ...
326 my $daemon = My::Daemon->new_with_options();
328 my ($command) = @{$daemon->extra_argv}
329 defined $command || die "No command specified";
331 $daemon->start if $command eq 'start';
332 $daemon->status if $command eq 'status';
333 $daemon->restart if $command eq 'restart';
334 $daemon->stop if $command eq 'stop';
336 warn($daemon->status_message);
337 exit($daemon->exit_code);
341 Often you want to write a persistant daemon that has a pid file, and responds
342 appropriately to Signals. This module provides a set of basic roles as an
343 infrastructure to do that.
347 When going into background MooseX::Daemonize closes all open file
348 handles. This may interfere with you logging because it may also close the log
349 file handle you want to write to. To prevent this you can either defer opening
350 the log file until after start. Alternatively, use can use the
351 'dont_close_all_files' option either from the command line or in your .sh
354 Assuming you want to use Log::Log4perl for example you could expand the
355 MooseX::Daemonize example above like this.
359 return unless $self->is_daemon;
360 Log::Log4perl->init(\$log4perl_config);
361 my $logger = Log::Log4perl->get_logger();
362 $logger->info("Daemon started");
363 # your daemon code here ...
369 This list includes attributes brought in from other roles as well
370 we include them here for ease of documentation. All of these attributes
371 are settable though L<MooseX::Getopt>'s command line handling, with the
372 exception of C<is_daemon>.
376 =item I<progname Path::Class::Dir | Str>
378 The name of our daemon, defaults to C<$package_name =~ s/::/_/>;
380 =item I<pidbase Path::Class::Dir | Str>
382 The base for our PID, defaults to C</var/run/>
384 =item I<pidfile MooseX::Daemonize::Pid::File | Str>
386 The file we store our PID in, defaults to C<$pidbase/$progname.pid>
388 =item I<foreground Bool>
390 If true, the process won't background. Useful for debugging. This option can
391 be set via Getopt's -f.
393 =item I<no_double_fork Bool>
395 If true, the process will not perform the typical double-fork, which is extra
396 added protection from your process accidentally aquiring a controlling terminal.
397 More information can be found by Googling "double fork daemonize".
399 =item I<ignore_zombies Bool>
401 If true, the process will not clean up zombie processes.
402 Normally you don't want this.
404 =item I<dont_close_all_files Bool>
406 If true, the objects open filehandles will not be closed when daemonized.
407 Normally you don't want this.
410 =item I<is_daemon Bool>
412 If true, the process is the backgrounded daemon process, if false it is the
413 parent process. This is useful for example in an C<after 'start' => sub { }>
416 B<NOTE:> This option is explicitly B<not> available through L<MooseX::Getopt>.
418 =item I<stop_timeout>
420 Number of seconds to wait for the process to stop, before trying harder to kill
421 it. Defaults to 2 seconds.
425 These are the internal attributes, which are not available through MooseX::Getopt.
429 =item I<exit_code Int>
431 =item I<status_message Str>
437 =head2 Daemon Control Methods
439 These methods can be used to control the daemon behavior. Every effort
440 has been made to have these methods DWIM (Do What I Mean), so that you
441 can focus on just writing the code for your daemon.
443 Extending these methods is best done with the L<Moose> method modifiers,
444 such as C<before>, C<after> and C<around>.
450 Setup a pidfile, fork, then setup the signal handlers.
454 Stop the process matching the pidfile, and unlinks the pidfile.
470 =head2 Pidfile Handling Methods
474 =item B<init_pidfile>
476 This method will create a L<MooseX::Daemonize::Pid::File> object and tell
477 it to store the PID in the file C<$pidbase/$progname.pid>.
481 This checks to see if the daemon process is currently running by checking
486 Returns the PID of the daemon process.
498 =head2 Signal Handling Methods
502 =item B<setup_signals>
504 Setup the signal handlers, by default it only sets up handlers for SIGINT and
505 SIGHUP. If you wish to add more signals just use the C<after> method modifier
508 =item B<handle_sigint>
510 Handle a INT signal, by default calls C<$self->stop()>
512 =item B<handle_sighup>
514 Handle a HUP signal. By default calls C<$self->restart()>
518 =head2 Exit Code Methods
520 These are overriable constant methods used for setting the exit code.
540 The C<meta()> method from L<Class::MOP::Class>
546 L<Moose>, L<MooseX::Getopt>, L<MooseX::Types::Path::Class> and L<POSIX>
548 =head1 INCOMPATIBILITIES
550 None reported. Although obviously this will not work on Windows.
552 =head1 BUGS AND LIMITATIONS
554 No bugs have been reported.
556 Please report any bugs or feature requests to
557 C<bug-acme-dahut-call@rt.cpan.org>, or through the web interface at
558 L<http://rt.cpan.org>.
562 L<Proc::Daemon>, L<Daemon::Generic>
566 Chris Prather C<< <chris@prather.org >>
568 Stevan Little C<< <stevan.little@iinteractive.com> >>
572 Mike Boyko, Matt S. Trout, Stevan Little, Brandon Black, Ash Berlin and the
575 Some bug fixes sponsored by Takkle Inc.
577 =head1 LICENCE AND COPYRIGHT
579 Copyright (c) 2007-2011, Chris Prather C<< <chris@prather.org> >>. Some rights
582 This module is free software; you can redistribute it and/or
583 modify it under the same terms as Perl itself. See L<perlartistic>.
585 =head1 DISCLAIMER OF WARRANTY
587 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
588 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
589 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
590 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
591 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
592 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
593 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
594 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
595 NECESSARY SERVICING, REPAIR, OR CORRECTION.
597 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
598 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
599 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
600 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
601 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
602 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
603 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
604 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
605 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF