daemons 1.1.6 → 1.1.8

data/LICENSE

@@ -20,10 +20,3 @@ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
-
-This license does not apply to daemonize.rb, which is was written by 
-Travis Whitton und published under the following license:
-
-The Daemonize extension module is copywrited free software by Travis Whitton
-<whitton@atlantic.net>. You can redistribute it under the terms specified in
-the COPYING file of the Ruby distribution.

data/README

@@ -1,4 +1,4 @@
-= Daemons Version 1.1.6
+= Daemons Version 1.1.8
 
 (See Releases for release-specific information)
 
@@ -14,9 +14,6 @@ Besides this basic functionality, daemons offers many advanced features like <i>
 and logging (in case your ruby script crashes) and <i>monitoring</i> and automatic restarting of your processes
 if they crash.
 
-Daemons includes the <tt>daemonize.rb</tt> script written by <i>Travis Whitton</i> to do the daemonization
-process.
-
 == Basic Usage
 
 You can use Daemons in four different ways:
@@ -189,7 +186,7 @@ Anonymous SVN checkout is available with "svn checkout http://daemons.rubyforge.
 
 == License
 
-Copyright (c) 2005-2010 Thomas Uehlinger
+Copyright (c) 2005-2012 Thomas Uehlinger
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -212,13 +209,6 @@ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
-This license does not apply to daemonize.rb, which is was written by 
-Travis Whitton und published under the following license:
-
-The Daemonize extension module is copywrited free software by Travis Whitton
-<whitton@atlantic.net>. You can redistribute it under the terms specified in
-the COPYING file of the Ruby distribution.
-
 == Feedback and other resources
 
 At http://rubyforge.org/projects/daemons.

data/Releases

@@ -1,5 +1,15 @@
 = Daemons Release History
 
+== Release 1.1.8: February 7, 2012
+
+* rename to daemonization.rb to daemonize.rb (and Daemonization to Daemonize) to 
+  ensure compatibility.
+
+== Release 1.1.7: February 6, 2012
+
+* start_proc: Write out the PID file in the newly created proc to avoid race conditions.
+* daemonize.rb: remove to simplify licensing (replaced by daemonization.rb).
+
 == Release 1.1.6: January 18, 2012
 
 * Add the :app_name option for the "call" daemonization mode.

data/examples/run/ctrl_slowstop.rb

@@ -0,0 +1,16 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
+
+if File.exist?(File.join(lib_dir, 'daemons.rb'))
+  $LOAD_PATH.unshift lib_dir
+else
+  begin; require 'rubygems'; rescue ::Exception; end
+end
+
+require 'daemons'
+
+options = {
+  #:force_kill_waittime => 40
+  #:force_kill_waittime => -1    # do not wait before killing -9
+}
+
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver_slowstop.rb'), options)

data/examples/run/myserver_slowstop.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+
+# This is myserver_slowstop.rb, an example server that is to be controlled by daemons
+# and that does nothing really useful at the moment.
+#
+# Don't run this script by yourself, it can be controlled by the ctrl*.rb scripts.
+
+trap('TERM') {
+  puts "received TERM"
+  
+  # simulate the slow stopping
+  sleep(10)
+  
+  exit
+}
+
+loop do
+  puts 'ping from myserver.rb!'
+  sleep(3)
+end

data/lib/daemons.rb

@@ -66,7 +66,7 @@ require 'timeout'
 #
 module Daemons
 
-  VERSION = "1.1.6"
+  VERSION = "1.1.8"
   
   require 'daemons/daemonize'
   

data/lib/daemons/application.rb

@@ -206,6 +206,9 @@ module Daemons
       return unless p = options[:proc]
     
       myproc = proc do 
+        
+        @pid.pid = Process.pid
+        
         # We need this to remove the pid-file if the applications exits by itself.
         # Note that <tt>at_text</tt> will only be run if the applications exits by calling 
         # <tt>exit</tt>, and not if it calls <tt>exit!</tt> (so please don't call <tt>exit!</tt>
@@ -246,17 +249,17 @@ module Daemons
           end
         }
         
+        started()
+        
         p.call()
       end
       
       unless options[:ontop]
-        @pid.pid = Daemonize.call_as_daemon(myproc, output_logfile, @group.app_name)
+        Daemonize.call_as_daemon(myproc, output_logfile, @group.app_name)
         
       else
         Daemonize.simulate(output_logfile)
         
-        @pid.pid = Process.pid
-        
         myproc.call
         
 # why did we use this??
@@ -273,7 +276,6 @@ module Daemons
         # end
       end
       
-      started()
     end
     
     

data/lib/daemons/daemonize.rb

@@ -1,97 +1,5 @@
-#--
-###############################################################################
-# daemonize.rb is a slightly modified version of daemonize.rb was             #
-# from the Daemonize Library written by Travis Whitton                        #
-# for details, read the notice below                                          #
-###############################################################################
-#++
-#
-#
-# =Daemonize Library
-# 
-# February. 4, 2005 Travis Whitton <whitton@atlantic.net>
-# 
-# Daemonize allows you to easily modify any existing Ruby program to run
-# as a daemon. See README.rdoc for more details.
-# 
-# == How to install
-# 1. su to root
-# 2. ruby install.rb
-# build the docs if you want to
-# 3. rdoc --main README.rdoc daemonize.rb README.rdoc
-# 
-# == Copying
-# The Daemonize extension module is copywrited free software by Travis Whitton
-# <whitton@atlantic.net>. You can redistribute it under the terms specified in
-# the COPYING file of the Ruby distribution.
-# 
-# == WARRANTY
-# THIS SOFTWARE 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.
-#
-#
-# ----
-#
-# == Purpose
-# 
-# Daemonize is a module derived from Perl's Proc::Daemon module. This module
-# allows you to easily modify any existing Ruby program to run as a daemon.
-# A daemon is a process that runs in the background with no controlling terminal.
-# Generally servers (like FTP and HTTP servers) run as daemon processes.
-# Note, do not make the mistake that a daemon == server. Converting a program
-# to a daemon by hand is a relatively simple process; however, this module will
-# save you the effort of repeatedly looking up the procedure, and it will also
-# insure that your programs are daemonized in the safest and most corrects
-# fashion possible.
-# 
-# == Procedure
-# 
-# The Daemonize module does the following:
-# 
-# Forks a child and exits the parent process.
-# 
-# Becomes a session leader (which detaches the program from
-# the controlling terminal).
-# 
-# Forks another child process and exits first child. This prevents
-# the potential of acquiring a controlling terminal.
-# 
-# Changes the current working directory to "/".
-# 
-# Clears the file creation mask.
-# 
-# Closes file descriptors.
-# 
-# == Example usage
-# 
-# Using the Daemonize module is extremely simple:
-# 
-#     require 'daemonize'
-# 
-#     class TestDaemon
-#       include Daemonize
-# 
-#       def initialize
-#         daemonize()
-#         loop do
-#           # do some work here
-#         end
-#       end
-#     end
-# 
-# == Credits
-# 
-# Daemonize was written by Travis Whitton and is based on Perl's
-# Proc::Daemonize, which was written by Earl Hood. The above documentation
-# is also partially borrowed from the Proc::Daemonize POD documentation.
-
-
-
 module Daemonize
-  VERSION = "0.1.1m"
-
+  
   # Try to fork if at all possible retrying every 5 sec if the
   # maximum process limit for the system has been reached
   def safefork
@@ -112,37 +20,29 @@ module Daemonize
   module_function :safefork
   
   
+  # Simulate the daemonization process (:ontop mode)
+  # NOTE: STDOUT and STDERR will not be redirected to the logfile, 
+  # because in :ontop mode, we normally want to see the output
   def simulate(logfile_name = nil)
-    # NOTE: STDOUT and STDERR will not be redirected to the logfile, because in :ontop mode, we normally want to see the output
-    
-    Dir.chdir "/"   # Release old working directory
+    # Release old working directory
+    Dir.chdir "/"   
 
-    # Make sure all file descriptors are closed
-    ObjectSpace.each_object(IO) do |io|
-      unless [STDIN, STDOUT, STDERR].include?(io)
-        begin
-          unless io.closed?
-            io.close
-          end
-        rescue ::Exception
-        end
-      end
-    end
+    close_io()
 
-    # Free file descriptors and
-    # point them somewhere sensible
-    # STDOUT/STDERR should go to a logfile
-    
+    # Free STDIN and point them somewhere sensible
     begin; STDIN.reopen "/dev/null"; rescue ::Exception; end       
   end
   module_function :simulate
   
   
+  # Call a given block as a daemon
   def call_as_daemon(block, logfile_name = nil, app_name = nil)
+    # we use a pipe to return the PID of the daemon
     rd, wr = IO.pipe
     
     if tmppid = safefork
-      # parent
+      # in the parent
+      
       wr.close
       pid = rd.read.to_i
       rd.close
@@ -151,7 +51,7 @@ module Daemonize
       
       return pid
     else
-      # child
+      # in the child
       
       rd.close
       
@@ -161,40 +61,19 @@ module Daemonize
       end
   
       # Prevent the possibility of acquiring a controlling terminal
-      #if oldmode.zero?
-        trap 'SIGHUP', 'IGNORE'
-        exit if pid = safefork
-      #end
+      trap 'SIGHUP', 'IGNORE'
+      exit if pid = safefork
   
       wr.write Process.pid
       wr.close
       
-      # Always handle INT signal (thanks to Vit Ondruch)
-      #trap 'INT', 'DEFAULT'  # make sure we always handle the 'INT' signal
-      
       $0 = app_name if app_name
       
-      Dir.chdir "/"   # Release old working directory
+      # Release old working directory
+      Dir.chdir "/"   
   
-      # Make sure all file descriptors are closed
-      ObjectSpace.each_object(IO) do |io|
-        unless [STDIN, STDOUT, STDERR].include?(io)
-          begin
-            unless io.closed?
-              io.close
-            end
-          rescue ::Exception
-          end
-        end
-      end
-      
-      ios = Array.new(8192){|i| IO.for_fd(i) rescue nil}.compact
-      ios.each do |io|
-        next if io.fileno < 3
-        io.close
-      end
+      close_io()
 
-  
       redirect_io(logfile_name)  
     
       block.call
@@ -205,10 +84,13 @@ module Daemonize
   module_function :call_as_daemon
   
   
-  # This method causes the current running process to become a daemon
+  # Transform the current process into a daemon
   def daemonize(logfile_name = nil, app_name = nil)
-    srand # Split rand streams between spawning and daemonized process
-    safefork and exit # Fork and exit from the parent
+    # Split rand streams between spawning and daemonized process
+    srand 
+    
+     # Fork and exit from the parent
+    safefork and exit
 
     # Detach from the controlling terminal
     unless sess_id = Process.setsid
@@ -216,19 +98,26 @@ module Daemonize
     end
 
     # Prevent the possibility of acquiring a controlling terminal
-    #if oldmode.zero?
-      trap 'SIGHUP', 'IGNORE'
-      exit if pid = safefork
-    #end
-
-    # Always handle INT signal (thanks to Vit Ondruch)
-    #trap 'INT', 'DEFAULT'  # make sure we always handle the 'INT' signal
+    trap 'SIGHUP', 'IGNORE'
+    exit if pid = safefork
     
     $0 = app_name if app_name
     
-    Dir.chdir "/"   # Release old working directory
+    # Release old working directory
+    Dir.chdir "/"  
+
+    close_io()
 
-    # Make sure all file descriptors are closed
+    redirect_io(logfile_name)
+    
+    return sess_id
+  end
+  module_function :daemonize
+  
+  
+  def close_io()
+    # Make sure all input/output streams are closed
+    # Part I: close all IO objects (except for STDIN/STDOUT/STDERR)
     ObjectSpace.each_object(IO) do |io|
       unless [STDIN, STDOUT, STDERR].include?(io)
         begin
@@ -239,18 +128,20 @@ module Daemonize
         end
       end
     end
-
-    redirect_io(logfile_name)
     
-    #return oldmode ? sess_id : 0   # Return value is mostly irrelevant
-    return sess_id
+    # Make sure all input/output streams are closed
+    # Part II: close all file decriptors (except for STDIN/STDOUT/STDERR)
+    ios = Array.new(8192) {|i| IO.for_fd(i) rescue nil}.compact
+    ios.each do |io|
+      next if io.fileno < 3
+      io.close
+    end
   end
-  module_function :daemonize
+  module_function :close_io
   
   
-  # Free file descriptors and
+  # Free STDIN/STDOUT/STDERR file descriptors and
   # point them somewhere sensible
-  # STDOUT/STDERR should go to a logfile
   def redirect_io(logfile_name)
     begin; STDIN.reopen "/dev/null"; rescue ::Exception; end       
      
@@ -271,4 +162,5 @@ module Daemonize
   end
   module_function :redirect_io
   
+  
 end

data/lib/daemons/pid.rb

@@ -1,4 +1,3 @@
-require 'open3'
 
 
 module Daemons

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 1
-  - 6
-  version: 1.1.6
+  - 8
+  version: 1.1.8
 platform: ruby
 authors: 
 - Thomas Uehlinger
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-17 00:00:00 +02:00
+date: 2012-02-07 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -61,10 +61,12 @@ files:
 - examples/run/ctrl_proc.rb
 - examples/run/ctrl_proc_multiple.rb
 - examples/run/ctrl_proc_simple.rb
+- examples/run/ctrl_slowstop.rb
 - examples/run/myserver.rb
 - examples/run/myserver_crashing.rb
 - examples/run/myserver_exiting.rb
 - examples/run/myserver_hanging.rb
+- examples/run/myserver_slowstop.rb
 - examples/call/call.rb
 - examples/call/call_monitor.rb
 - examples/daemonize/daemonize.rb