daemons 1.0.1 → 1.0.2

data/README

@@ -1,4 +1,4 @@
-= Daemons Version 1.0.1
+= Daemons Version 1.0.2
 
 (See Releases for release-specific information)
 

data/Releases

@@ -1,5 +1,14 @@
 = Daemons Release History
 
+== Release 1.0.2: September 26, 2006
+
+* Changed the 'ps -ax' call back to 'ps ax'.
+* Fixed the documentation for the :normal :dir_mode.
+* As a default for Daemons.run_proc, the pid file is now saved in the current directory.
+* In :ontop mode for running a proc (this is equal to calling something like 'ruby ctrl_proc.rb run'), 
+  the proc now runs directly in the calling script, not in a forked process anymore (thanks to Paul Butcher).
+* Set $0 to app_name in the daemons (thanks to Ilya Novoselov).
+
 == Release 1.0.1: August 30, 2006
 
 * Fixed a regex for parsing the 'ps ax' system call. (thanks to Garance Alistair Drosehn)

data/examples/call/call.rb

@@ -1,4 +1,4 @@
-lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
 
 if File.exists?(File.join(lib_dir, 'daemons.rb'))
   $LOAD_PATH.unshift lib_dir

data/examples/call/call_monitor.rb

@@ -1,4 +1,4 @@
-lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
 
 if File.exists?(File.join(lib_dir, 'daemons.rb'))
   $LOAD_PATH.unshift lib_dir

data/examples/daemonize/daemonize.rb

@@ -1,4 +1,4 @@
-lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
 
 if File.exists?(File.join(lib_dir, 'daemons.rb'))
   $LOAD_PATH.unshift lib_dir

data/examples/run/ctrl_crash.rb

@@ -1,4 +1,4 @@
-lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
 
 if File.exists?(File.join(lib_dir, 'daemons.rb'))
   $LOAD_PATH.unshift lib_dir
@@ -14,4 +14,4 @@ options = {
   :backtrace => true
 }
 
-Daemons.run(File.join(File.split(__FILE__)[0], 'myserver_crashing.rb'), options)
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver_crashing.rb'), options)

data/examples/run/ctrl_exec.rb

@@ -1,4 +1,4 @@
-lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
 
 if File.exists?(File.join(lib_dir, 'daemons.rb'))
   $LOAD_PATH.unshift lib_dir
@@ -10,7 +10,7 @@ require 'daemons'
 
 
 options = {
-  :exec => true
+  :mode => :exec
 }
 
-Daemons.run(File.join(File.split(__FILE__)[0], 'myserver.rb'), options)
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver.rb'), options)

data/examples/run/ctrl_exit.rb

@@ -1,4 +1,4 @@
-lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
 
 if File.exists?(File.join(lib_dir, 'daemons.rb'))
   $LOAD_PATH.unshift lib_dir
@@ -12,4 +12,4 @@ require 'daemons'
 options = {
 }
 
-Daemons.run(File.join(File.split(__FILE__)[0], 'myserver_exiting.rb'), options)
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver_exiting.rb'), options)

data/examples/run/ctrl_monitor.rb

@@ -1,4 +1,4 @@
-lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
 
 if File.exists?(File.join(lib_dir, 'daemons.rb'))
   $LOAD_PATH.unshift lib_dir
@@ -13,4 +13,4 @@ options = {
   :monitor => true
 }
 
-Daemons.run(File.join(File.split(__FILE__)[0], 'myserver_crashing.rb'), options)
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver_crashing.rb'), options)

data/examples/run/ctrl_multiple.rb

@@ -1,4 +1,4 @@
-lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
 
 if File.exists?(File.join(lib_dir, 'daemons.rb'))
   $LOAD_PATH.unshift lib_dir
@@ -13,4 +13,4 @@ options = {
   :multiple => true
 }
 
-Daemons.run(File.join(File.split(__FILE__)[0], 'myserver.rb'), options)
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver.rb'), options)

data/examples/run/ctrl_normal.rb

@@ -1,4 +1,4 @@
-lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
 
 if File.exists?(File.join(lib_dir, 'daemons.rb'))
   $LOAD_PATH.unshift lib_dir
@@ -9,4 +9,4 @@ end
 require 'daemons'
 
 
-Daemons.run(File.join(File.split(__FILE__)[0], 'myserver.rb'))
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver.rb'))

data/examples/run/ctrl_ontop.rb

@@ -1,4 +1,4 @@
-lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
 
 if File.exists?(File.join(lib_dir, 'daemons.rb'))
   $LOAD_PATH.unshift lib_dir
@@ -13,4 +13,4 @@ options = {
   :ontop => true
 }
 
-Daemons.run(File.join(File.split(__FILE__)[0], 'myserver.rb'), options)
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver.rb'), options)

data/examples/run/ctrl_proc.rb

@@ -1,4 +1,4 @@
-lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
 
 if File.exists?(File.join(lib_dir, 'daemons.rb'))
   $LOAD_PATH.unshift lib_dir

data/examples/run/ctrl_proc.rb.output

@@ -0,0 +1,25 @@
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!
+ping from proc!

data/examples/run/ctrl_proc_simple.rb

@@ -0,0 +1,17 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
+
+if File.exists?(File.join(lib_dir, 'daemons.rb'))
+  $LOAD_PATH.unshift lib_dir
+else
+  require 'rubygems' rescue nil
+end
+
+require 'daemons'
+
+           
+Daemons.run_proc('ctrl_proc_simple.rb') do
+  loop do
+    puts 'ping from proc!'
+    sleep(3)
+  end
+end

data/examples/run/myserver_exiting.rb

@@ -4,5 +4,5 @@ loop do
   
   sleep(3)
   
-  Process.exit!
-end
+  Process.exit
+end

data/lib/daemons.rb

@@ -65,7 +65,7 @@ require 'daemons/controller'
 #
 module Daemons
 
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
   
   require 'daemons/daemonize'
   
@@ -92,7 +92,7 @@ module Daemons
   # <tt>:dir_mode</tt>::  Either <tt>:script</tt> (the directory for writing the pid files to 
   #                       given by <tt>:dir</tt> is interpreted relative
   #                       to the script location given by +script+) or <tt>:normal</tt> (the directory given by 
-  #                       <tt>:dir</tt> is interpreted relative to the current directory) or <tt>:system</tt> 
+  #                       <tt>:dir</tt> is interpreted as a (absolute or relative) path) or <tt>:system</tt> 
   #                       (<tt>/var/run</tt> is used as the pid file directory)
   #
   # <tt>:dir</tt>::       Used in combination with <tt>:dir_mode</tt> (description above)
@@ -120,7 +120,7 @@ module Daemons
   #     :script     => "path/to/script.rb"
   #   }
   #
-  #   Daemons.run(File.join(File.split(__FILE__)[0], 'myscript.rb'), options)
+  #   Daemons.run(File.join(File.dirname(__FILE__), 'myscript.rb'), options)
   #
   def run(script, options = {})
     options[:script] = script
@@ -167,9 +167,10 @@ module Daemons
     options[:mode] = :proc
     options[:proc] = block
     
+    # we do not have a script location so the the :script option cannot be used, change it to :normal
     if [nil, :script].include? options[:dir_mode]
       options[:dir_mode] = :normal
-      options[:dir] = File.split(__FILE__)[0]
+      options[:dir] = File.expand_path('.')
     end
     
     @controller = Controller.new(options, ARGV)
@@ -260,7 +261,6 @@ module Daemons
     @group ||= ApplicationGroup.new('self', options)
     
     @group.new_application(:mode => :none).start
-    
   end
   module_function :daemonize
   

data/lib/daemons/application.rb

@@ -26,7 +26,7 @@ module Daemons
       
       unless @pid = pid
         if dir = pidfile_dir
-          @pid = PidFile.new(pidfile_dir(), @group.app_name, @group.multiple)
+          @pid = PidFile.new(dir, @group.app_name, @group.multiple)
         else
           @pid = PidMem.new
         end
@@ -45,9 +45,11 @@ module Daemons
       (options[:log_output] && pidfile_dir()) ? File.join(pidfile_dir(), @group.app_name + '.output') : nil
     end
     
+    
+    # this function is only used to daemonize the currently running process (Daemons.daemonize)
     def start_none
       unless options[:ontop]
-        Daemonize.daemonize #(logfile)
+        Daemonize.daemonize(nil, @group.app_name) #(logfile)
       else
         Daemonize.simulate
       end
@@ -86,11 +88,12 @@ module Daemons
     
     def start_exec
       unless options[:ontop]
-        Daemonize.daemonize(logfile)
+        Daemonize.daemonize(logfile, @group.app_name)
       else
         Daemonize.simulate(logfile)
       end
       
+      # note that we cannot remove the pid file if we run in :ontop mode (i.e. 'ruby ctrl_exec.rb run')
       @pid.pid = Process.pid
         
       ENV['DAEMONS_ARGV'] = @controller_argv.join(' ')      
@@ -101,7 +104,7 @@ module Daemons
     
     def start_load
       unless options[:ontop]
-        Daemonize.daemonize(logfile)
+        Daemonize.daemonize(logfile, @group.app_name)
       else
         Daemonize.simulate(logfile)
       end
@@ -137,7 +140,7 @@ module Daemons
         exit
       }
       
-      # Know we really start the script...
+      # Now we really start the script...
       $DAEMONS_ARGV = @controller_argv
       ENV['DAEMONS_ARGV'] = @controller_argv.join(' ')
       
@@ -149,32 +152,71 @@ module Daemons
     end
     
     def start_proc
-      return unless options[:proc]
+      return unless p = options[:proc]
+      
+      myproc = proc do
+        # 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>
+        # in your application!
+        #
+        at_exit {
+          @pid.cleanup rescue nil
+
+          # If the option <tt>:backtrace</tt> is used and the application did exit by itself
+          # create a exception log.
+          if options[:backtrace] and not options[:ontop] and not $daemons_sigterm
+            exception_log() rescue nil
+          end
+
+        }
+
+        # This part is needed to remove the pid-file if the application is killed by 
+        # daemons or manually by the user.
+        # Note that the applications is not supposed to overwrite the signal handler for
+        # 'TERM'.
+        #
+        trap('TERM') {
+          @pid.cleanup rescue nil
+          $daemons_sigterm = true
+
+          exit
+        }
+        
+        p.call()
+      end
       
       unless options[:ontop]
-        @pid.pid = Daemonize.call_as_daemon(options[:proc], logfile)
+        @pid.pid = Daemonize.call_as_daemon(myproc, logfile, @group.app_name)
       else
-#         Daemonize.simulate(logfile)
-#         
-#         @pid.pid = Process.pid
-#         
+        Daemonize.simulate(logfile)
+        
+        @pid.pid = Process.pid
+        
+        myproc.call
+        
+# why did we use this??
 #         Thread.new(&options[:proc])
-        unless @pid.pid = Process.fork
-          Daemonize.simulate(logfile)
-          options[:proc].call
-          exit
-        else
-          Process.detach(@pid.pid)
-        end
+
+# why did we use the code below??
+        # unless pid = Process.fork
+        #   @pid.pid = pid
+        #   Daemonize.simulate(logfile)
+        #   options[:proc].call
+        #   exit
+        # else
+        #   Process.detach(@pid.pid)
+        # end
       end
     end
     
     
     def start
-      @group.create_monitor(@group.applications[0] || self)
+      @group.create_monitor(@group.applications[0] || self) unless options[:ontop]  # we don't monitor applications in the foreground
       
       case options[:mode]
         when :none
+          # this is only used to daemonize the currently running process
           start_none
         when :exec
           start_exec

data/lib/daemons/controller.rb

@@ -32,7 +32,7 @@ module Daemons
         @app_name ||= File.split(@script)[1]
       end
     
-      @app_name = options[:app_name] if options[:app_name]
+      @app_name ||= 'unknown_application'
       
       @command, @controller_part, @app_part = Controller.split_argv(argv)
     

data/lib/daemons/daemonize.rb

@@ -113,7 +113,7 @@ module Daemonize
   
   
   def simulate(logfile_name = nil)
-    # NOTE: STDOUT and STDERR will not be redirected to the logfile!
+    # 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
     File.umask 0000 # Insure sensible umask
@@ -139,7 +139,7 @@ module Daemonize
   module_function :simulate
   
   
-  def call_as_daemon(block, logfile_name = nil, oldmode = 0)
+  def call_as_daemon(block, logfile_name = nil, app_name = nil)
     rd, wr = IO.pipe
     
     if tmppid = safefork
@@ -152,6 +152,8 @@ module Daemonize
       
       return pid
     else
+      # child
+      
       rd.close
       
       # Detach from the controlling terminal
@@ -160,14 +162,16 @@ module Daemonize
       end
   
       # Prevent the possibility of acquiring a controlling terminal
-      if oldmode.zero?
+      #if oldmode.zero?
         trap 'SIGHUP', 'IGNORE'
         exit if pid = safefork
-      end
+      #end
   
       wr.write Process.pid
       wr.close
       
+      $0 = app_name if app_name
+      
       Dir.chdir "/"   # Release old working directory
       File.umask 0000 # Insure sensible umask
   
@@ -210,7 +214,7 @@ module Daemonize
   
   
   # This method causes the current running process to become a daemon
-  def daemonize(logfile_name = nil, oldmode=0)
+  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
 
@@ -220,11 +224,13 @@ module Daemonize
     end
 
     # Prevent the possibility of acquiring a controlling terminal
-    if oldmode.zero?
+    #if oldmode.zero?
       trap 'SIGHUP', 'IGNORE'
       exit if pid = safefork
-    end
+    #end
 
+    $0 = app_name if app_name
+    
     Dir.chdir "/"   # Release old working directory
     File.umask 0000 # Insure sensible umask
 
@@ -258,7 +264,8 @@ module Daemonize
      
     STDERR.reopen STDOUT rescue nil           
     
-    return oldmode ? sess_id : 0   # Return value is mostly irrelevant
+    #return oldmode ? sess_id : 0   # Return value is mostly irrelevant
+    return sess_id
   end
   module_function :daemonize
   

data/lib/daemons/pid.rb

@@ -1,72 +1,75 @@
-
-module Daemons
-
-  class Pid
-  
-    def Pid.running?(pid, additional = nil)
-      match_pid = Regexp.new("^\\s*#{pid}\\s")
-      got_match = false
-
-      ps_all = IO.popen("ps -ax")
-      ps_all.each { |psline|
-        next unless psline =~ match_pid
-        got_match = true
-        got_match = false if additional and psline !~ /#{additional}/
-        break
-      }
-      ps_all.close
-
-      return got_match
-    end
-    
-    
-    # Returns the directory that should be used to write the pid file to
-    # depending on the given mode.
-    # 
-    # Some modes may require an additionaly hint, others may determine 
-    # the directory automatically.
-    #
-    # If no valid directory is found, returns nil.
-    #
-    def Pid.dir(dir_mode, dir, script)
-      # nil script parameter is allowed so long as dir_mode is not :script
-      return nil if dir_mode == :script && script.nil?                         
-      
-      case dir_mode
-        when :normal
-          return File.expand_path(dir)
-        when :script
-          return File.expand_path(File.join(File.split(script)[0],dir))
-        when :system  
-          return '/var/run'
-        else
-          raise Error.new("pid file mode '#{dir_mode}' not implemented")
-      end
-    end
-    
-    # Initialization method
-    def initialize
-    end
-    
-    
-    # Get method
-    def pid
-    end
-    
-    # Set method
-    def pid=(p)
-    end
-    
-    # Cleanup method
-    def cleanup
-    end
-    
-    # Exists? method
-    def exists?
-      true
-    end
-    
-  end  
-  
-  
+
+module Daemons
+
+  class Pid
+  
+    def Pid.running?(pid, additional = nil)
+      match_pid = Regexp.new("^\\s*#{pid}\\s")
+      got_match = false
+
+      ps_all = IO.popen("ps ax") # the correct syntax is without a dash (-) !
+      ps_all.each { |psline|
+        next unless psline =~ match_pid
+        got_match = true
+        got_match = false if additional and psline !~ /#{additional}/
+        break
+      }
+      ps_all.close
+
+      # an alternative would be to use the code below, but I don't know whether this is portable
+      # `ps axo pid=`.split.include? pid.to_s
+       
+      return got_match
+    end
+    
+    
+    # Returns the directory that should be used to write the pid file to
+    # depending on the given mode.
+    # 
+    # Some modes may require an additionaly hint, others may determine 
+    # the directory automatically.
+    #
+    # If no valid directory is found, returns nil.
+    #
+    def Pid.dir(dir_mode, dir, script)
+      # nil script parameter is allowed as long as dir_mode is not :script
+      return nil if dir_mode == :script && script.nil?                         
+      
+      case dir_mode
+        when :normal
+          return File.expand_path(dir)
+        when :script
+          return File.expand_path(File.join(File.dirname(script),dir))
+        when :system  
+          return '/var/run'
+        else
+          raise Error.new("pid file mode '#{dir_mode}' not implemented")
+      end
+    end
+    
+    # Initialization method
+    def initialize
+    end
+    
+    
+    # Get method
+    def pid
+    end
+    
+    # Set method
+    def pid=(p)
+    end
+    
+    # Cleanup method
+    def cleanup
+    end
+    
+    # Exists? method
+    def exists?
+      true
+    end
+    
+  end  
+  
+  
 end

data/lib/daemons/pidfile.rb

@@ -25,9 +25,9 @@ module Daemons
   # 
   # Daemons is configurable to store the Pid-Files relative to three different locations:
   # 1.  in a directory relative to the directory where the script (the one that is supposed to run
-  #     as a daemon) resides
-  # 2.  in a directory relative to the current directory or the filesystem root
-  # 3.  in the preconfigured directory <tt>/var/run</tt>
+  #     as a daemon) resides (<tt>:script</tt> option for <tt>:dir_mode</tt>)
+  # 2.  in a directory given by <tt>:dir</tt> (<tt>:normal</tt> option for <tt>:dir_mode</tt>)
+  # 3.  in the preconfigured directory <tt>/var/run</tt> (<tt>:system</tt> option for <tt>:dir_mode</tt>)
   #
   class PidFile < Pid
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: daemons
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
-date: 2006-08-30 00:00:00 +02:00
+  version: 1.0.2
+date: 2006-10-04 00:00:00 +02:00
 summary: A toolkit to create and control daemons in different ways
 require_paths: 
 - lib
@@ -66,6 +66,7 @@ files:
 - examples/run/ctrl_proc.output
 - examples/run/ctrl_proc.rb
 - examples/run/ctrl_proc.rb.output
+- examples/run/ctrl_proc_simple.rb
 - examples/run/myserver.rb
 - examples/run/myserver_crashing.rb
 - examples/run/myserver_crashing.rb.output