daemons 1.0.9 → 1.0.10

data/README

@@ -1,4 +1,4 @@
-= Daemons Version 1.0.9
+= Daemons Version 1.0.10
 
 (See Releases for release-specific information)
 
@@ -184,12 +184,11 @@ The RDoc documentation is also online at http://daemons.rubyforge.org
 
 == Author
 
-Written in 2005-2007 by Thomas Uehlinger <mailto:th.uehlinger@gmx.ch>.
-Homepage: http://physiker.ch
+Written in 2005-2008 by Thomas Uehlinger <mailto:th.uehlinger@gmx.ch>.
 
 == License
 
-Copyright (c) 2005-2007 Thomas Uehlinger
+Copyright (c) 2005-2008 Thomas Uehlinger
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 Gem::manage_gems
 
 require 'rake/gempackagetask'
-require 'rake/testtask'
+#require 'rake/testtask'
 require 'rake/packagetask'
 require 'rake/rdoctask'
 
@@ -16,7 +16,7 @@ PKG_FILES = FileList[
   "Rakefile", "Releases", "TODO", "README", "LICENSE",
   "setup.rb",
   "lib/**/*.rb",
-  "test/**/*",
+  #"test/**/*",
   "examples/**/*"
 ]
 #PKG_FILES.exclude(%r(^test/tmp/.+))
@@ -48,7 +48,6 @@ spec = Gem::Specification.new do |s|
   s.files = PKG_FILES
   s.require_path = "lib"
   s.autorequire = "daemons"
-  s.test_file = "test/tc_main.rb"
   s.has_rdoc = true
   s.extra_rdoc_files = ["README", "Releases", "TODO"]
 end
@@ -67,11 +66,8 @@ end
 #end
 
  
-task :default => [:test]
+task :default => [:package]
 
-Rake::TestTask.new(:test) do |t|
-  t.test_files = FileList['test/tc_*.rb']
-end
 
 task :upload do
   sh "scp -r html/* uehli@rubyforge.org:/var/www/gforge-projects/daemons"
@@ -85,5 +81,4 @@ rd = Rake::RDocTask.new("rdoc") { |rdoc|
   rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
   rdoc.rdoc_files.include('README', 'TODO', 'Releases')
   rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_files.include('test/**/*.rb')
 }

data/Releases

@@ -1,5 +1,15 @@
 = Daemons Release History
 
+== Release 1.0.10: November 16, 2007
+
+* By default, we now delete stray pid-files (i.e. pid-files which result for 
+  example from a killed daemon) automatically. This function can be deactivated by
+  passing :keep_pid_files => true as an option.
+* All pid files of :multiple daemons new get deleted correctly upon exit of the daemons (reported by Han Holl).
+* Use the signal 'KILL' instead of 'TERM' on Windows platforms.
+* Use exit! in trap('TERM') instead of exit when option :hard_exit is given (thanks to Han Holl).
+* Did some clarification on the exception log.
+
 == Release 1.0.9: October 29, 2007
 
 * fixed a severe bug in the new Pid.running? function: function returned true if the process did not exist (thanks to Jeremy Lawler).

data/examples/run/ctrl_keep_pid_files.rb

@@ -0,0 +1,17 @@
+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 = {
+  :keep_pid_files => true
+}
+
+
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver.rb'), options)

data/examples/run/ctrl_proc_multiple.rb

@@ -0,0 +1,22 @@
+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 = {
+  :log_output => true,
+  :multiple => true, 
+}
+
+
+Daemons.run_proc('ctrl_proc_multiple.rb', options) do
+  puts "hello"
+  sleep(5)
+  puts "done"
+end

data/examples/run/ctrl_proc_multiple.rb.output

@@ -0,0 +1,2 @@
+
+hello

data/examples/run/myserver_crashing.rb.output

@@ -13,3 +13,18 @@
 ping from myserver.rb!
 this example server will crash in 3 seconds...
 CRASH!
+ping from myserver.rb!
+this example server will crash in 3 seconds...
+CRASH!
+/Users/uehli/Projects/daemons-proj/examples/run/myserver_crashing.rb:13: CRASH! (RuntimeError)
+	from /Users/uehli/Projects/daemons-proj/examples/run/myserver_crashing.rb:6:in `loop'
+	from /Users/uehli/Projects/daemons-proj/examples/run/myserver_crashing.rb:6
+	from /Users/uehli/Projects/daemons-proj/lib/daemons/application.rb:176:in `load'
+	from /Users/uehli/Projects/daemons-proj/lib/daemons/application.rb:176:in `start_load'
+	from /Users/uehli/Projects/daemons-proj/lib/daemons/application.rb:257:in `start'
+	from /Users/uehli/Projects/daemons-proj/lib/daemons/controller.rb:69:in `run'
+	from /Users/uehli/Projects/daemons-proj/lib/daemons.rb:139:in `run'
+	from /Users/uehli/Projects/daemons-proj/lib/daemons/cmdline.rb:105:in `call'
+	from /Users/uehli/Projects/daemons-proj/lib/daemons/cmdline.rb:105:in `catch_exceptions'
+	from /Users/uehli/Projects/daemons-proj/lib/daemons.rb:138:in `run'
+	from ctrl_crash.rb:17

data/lib/daemons.rb

@@ -38,7 +38,7 @@ require 'daemons/controller'
 #
 # == What does daemons internally do with my daemons?
 # *or*:: why do my daemons crash when they try to open a file?
-# *or*:: why can I not see any output from the daemon on the console (when using for example +puts+?
+# *or*:: why can I not see any output from the daemon on the console (when using for example +puts+)?
 #
 # From a technical aspect of view, daemons does the following when creating a daemon:
 #
@@ -48,7 +48,7 @@ require 'daemons/controller'
 # 3.  Forks another child process and exits first child. This prevents
 #     the potential of acquiring a controlling terminal.
 # 4.  Changes the current working directory to "/".
-# 5.  Clears the file creation mask (sets +umask+ to +0000+).
+# 5.  Clears the file creation mask (sets +umask+ to 0000).
 # 6.  Closes file descriptors (reopens +STDOUT+ and +STDERR+ to point to a logfile if
 #     possible).
 #
@@ -65,7 +65,7 @@ require 'daemons/controller'
 #
 module Daemons
 
-  VERSION = "1.0.9"
+  VERSION = "1.0.10"
   
   require 'daemons/daemonize'
   
@@ -90,6 +90,9 @@ module Daemons
   #                       and log files. Defaults to the basename of
   #                       the script.
   # <tt>:ARGV</tt>::      An array of strings containing parameters and switches for Daemons.
+  #                       This includes both parameters for Daemons itself and the controlled scripted.
+  #                       These are assumed to be separated by an array element '--', .e.g.
+  #                       ['start', 'f', '--', 'param1_for_script', 'param2_for_script'].
   #                       If not given, ARGV (the parameters given to the Ruby process) will be used.
   # <tt>:dir_mode</tt>::  Either <tt>:script</tt> (the directory for writing the pid files to 
   #                       given by <tt>:dir</tt> is interpreted relative
@@ -107,23 +110,23 @@ module Daemons
   # <tt>:backtrace</tt>:: Write a backtrace of the last exceptions to the file '[app_name].log' in the 
   #                       pid-file directory if the application exits due to an uncaught exception
   # <tt>:monitor</tt>::   Monitor the programs and restart crashed instances
-  # <tt>:log_output</tt>:: When given (i.e. set to true), redirect both STDOUT and STDERR to a logfile 
-  #                       named '[app_name].output' in the pid-file directory
-  #
+  # <tt>:log_output</tt>:: When given (i.e. set to true), redirect both STDOUT and STDERR to a logfile named '[app_name].output' in the pid-file directory
+  # <tt>:keep_pid_files</tt>:: When given do not delete lingering pid-files (files for which the process is no longer running).
+  # <tt>:hard_exit</tt>:: When given use exit! to end a daemons instead of exit (this will for example
+  #                       not call at_exit handlers).
   # -----
   # 
   # === Example:
   #   options = {
   #     :app_name   => "my_app",
-  #     :ARGV       => ['start', '-f']
+  #     :ARGV       => ['start', '-f', '--', 'param_for_myscript']
   #     :dir_mode   => :script,
   #     :dir        => 'pids',
   #     :multiple   => true,
   #     :ontop      => true,
   #     :mode       => :exec,
   #     :backtrace  => true,
-  #     :monitor    => true,
-  #     :script     => "path/to/script.rb"
+  #     :monitor    => true
   #   }
   #
   #   Daemons.run(File.join(File.dirname(__FILE__), 'myscript.rb'), options)
@@ -173,7 +176,7 @@ 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
+    # we do not have a script location so the the :script :dir_mode cannot be used, change it to :normal
     if [nil, :script].include? options[:dir_mode]
       options[:dir_mode] = :normal
       options[:dir] = File.expand_path('.')

data/lib/daemons/application.rb

@@ -19,6 +19,9 @@ module Daemons
     attr_reader :options
     
     
+    SIGNAL = (RUBY_PLATFORM =~ /win32/ ? 'KILL' : 'TERM')
+    
+    
     def initialize(group, add_options = {}, pid = nil)
       @group = group
       @options = group.options.dup
@@ -85,15 +88,23 @@ module Daemons
       # Note that the applications is not supposed to overwrite the signal handler for
       # 'TERM'.
       #
-      trap('TERM') {
+      trap(SIGNAL) {
         begin; @pid.cleanup; rescue ::Exception; end
         $daemons_sigterm = true
         
-        exit
+        if options[:hard_exit]
+          exit!
+        else
+          exit
+        end
       }
     end
     
     def start_exec
+      if options[:backtrace]
+        puts "option :backtrace is not supported with :mode => :exec, ignoring"
+      end
+      
       unless options[:ontop]
         Daemonize.daemonize(output_logfile, @group.app_name)
       else
@@ -106,6 +117,8 @@ module Daemons
       ENV['DAEMONS_ARGV'] = @controller_argv.join(' ')      
       # haven't tested yet if this is really passed to the exec'd process...
       
+      
+      
       Kernel.exec(script(), *(@app_argv || []))
       #Kernel.exec(script(), *ARGV)
     end
@@ -141,11 +154,15 @@ module Daemons
       # Note that the applications is not supposed to overwrite the signal handler for
       # 'TERM'.
       #
-      trap('TERM') {
+      trap(SIGNAL) {
         begin; @pid.cleanup; rescue ::Exception; end
         $daemons_sigterm = true
         
-        exit
+        if options[:hard_exit]
+          exit!
+        else
+          exit
+        end
       }
       
       # Now we really start the script...
@@ -161,8 +178,8 @@ module Daemons
     
     def start_proc
       return unless p = options[:proc]
-      
-      myproc = proc do
+    
+      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>
@@ -184,11 +201,15 @@ module Daemons
         # Note that the applications is not supposed to overwrite the signal handler for
         # 'TERM'.
         #
-        trap('TERM') {
+        trap(SIGNAL) {
           begin; @pid.cleanup; rescue ::Exception; end
           $daemons_sigterm = true
 
-          exit
+          if options[:hard_exit]
+            exit!
+          else
+            exit
+          end
         }
         
         p.call()
@@ -270,17 +291,19 @@ module Daemons
       
       l_file = Logger.new(logfile)
       
-      # the code below only logs the last exception
-#       e = nil
-#       
-#       ObjectSpace.each_object {|o|
-#         if ::Exception === o
-#           e = o
-#         end
-#       }
-#       
-#       l_file.error e
-#       l_file.close
+      # the code below finds the last exception
+      e = nil
+      
+      ObjectSpace.each_object {|o|
+        if ::Exception === o
+          e = o
+        end
+      }
+     
+      l_file.info "*** below you find the most recent exception thrown, this will be likely (but not certainly) the exception that made the application exit abnormally ***"
+      l_file.error e
+      
+      l_file.info "*** below you find all exception objects found in memory, some of them may have been thrown in your application, others may just be in memory because they are standard exceptions ***"
       
       # this code logs every exception found in memory
       ObjectSpace.each_object {|o|
@@ -304,7 +327,7 @@ module Daemons
       # restarted by the monitor yet. By catching the error, we allow the
       # pid file clean-up to occur.
       begin
-        Process.kill('TERM', @pid.pid)
+        Process.kill(SIGNAL, @pid.pid)
       rescue Errno::ESRCH => e
         puts "#{e} #{@pid.pid}"
         puts "deleting pid-file."

data/lib/daemons/application_group.rb

@@ -41,6 +41,8 @@ module Daemons
       @dir_mode = options[:dir_mode] || :script
       @dir = options[:dir] || ''
       
+      @keep_pid_files = options[:keep_pid_files] || false
+      
       #@applications = find_applications(pidfile_dir())
       @applications = []
     end
@@ -58,7 +60,7 @@ module Daemons
     end  
     
     def find_applications(dir)
-      pid_files = PidFile.find_files(dir, app_name)
+      pid_files = PidFile.find_files(dir, app_name, ! @keep_pid_files)
       
       #pp pid_files
       

data/lib/daemons/monitor.rb

@@ -6,7 +6,7 @@ module Daemons
   class Monitor
     
     def self.find(dir, app_name)
-      pid = PidFile.find_files(dir, app_name)[0]
+      pid = PidFile.find_files(dir, app_name, false)[0]
       
       if pid
         pid = PidFile.existing(pid)
@@ -116,7 +116,7 @@ module Daemons
     
     
     def stop
-      begin; Process.kill('TERM', @pid.pid); rescue ::Exception; end
+      begin; Process.kill(Application::SIGNAL, @pid.pid); rescue ::Exception; end
       
       # We try to remove the pid-files by ourselves, in case the application
       # didn't clean it up.

data/lib/daemons/pid.rb

@@ -39,7 +39,7 @@ module Daemons
   #        break
   #      }
   #    ensure
-  #      begin; begin; ps_in.close; rescue ::Exception; end; ps_out.close rescue nil; ps_err.close; rescue ::Exception; end
+  #      begin; begin; ps_in.close; rescue ::Exception; end; begin; ps_out.close; rescue ::Exception; end; ps_err.close; rescue ::Exception; end
   #    end
   #    
   #    # an alternative would be to use the code below, but I don't know whether this is portable

data/lib/daemons/pidfile.rb

@@ -21,7 +21,7 @@ module Daemons
   #
   # Each file just contains one line with the pid as string (for example <tt>6432</tt>).
   #  
-  # === Where are Pid-Files stored?
+  # === Where are the Pid-Files stored?
   # 
   # 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
@@ -33,11 +33,22 @@ module Daemons
 
     attr_reader :dir, :progname, :multiple, :number
 
-    def PidFile.find_files(dir, progname)
+    def PidFile.find_files(dir, progname, delete = false)
       files = Dir[File.join(dir, "#{progname}*.pid")]
       
       files.delete_if {|f| not (File.file?(f) and File.readable?(f))}
-      
+      if delete 
+        files.delete_if do |f|
+          pid = File.open(f) {|h| h.read}.to_i
+          rsl =  ! Pid.running?(pid)
+          if rsl
+            puts "pid-file for killed process #{pid} found (#{f}), deleting."
+            begin; File.unlink(f); rescue ::Exception; end
+          end
+          rsl
+        end
+      end
+    
       return files
     end
     
@@ -59,6 +70,16 @@ module Daemons
       @multiple = multiple
       @number = nil
       @number = 0 if multiple
+      
+      if multiple
+        while File.exist?(filename) and @number < 1024
+          @number += 1
+        end
+        
+        if @number == 1024
+          raise RuntimeException('cannot run more than 1024 instances of the application')
+        end
+      end
     end
     
     def filename
@@ -70,16 +91,6 @@ module Daemons
     end
     
     def pid=(p)
-      if multiple
-        while File.exist?(filename) and @number < 1024
-          @number += 1
-        end
-        
-        if @number == 1024
-          raise RuntimeException('cannot run more than 1024 instances of the application')
-        end
-      end
-      
       File.open(filename, 'w') {|f|
         f.puts p   #Process.pid
       }

metadata

@@ -1,33 +1,28 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: daemons
 version: !ruby/object:Gem::Version 
-  version: 1.0.9
-date: 2007-10-29 00:00:00 +01:00
-summary: A toolkit to create and control daemons in different ways
-require_paths: 
-- lib
-email: th.uehlinger@gmx.ch
-homepage: http://daemons.rubyforge.org
-rubyforge_project: daemons
-description: Daemons provides an easy way to wrap existing ruby scripts (for example a self-written server)  to be run as a daemon and to be controlled by simple start/stop/restart commands.  You can also call blocks as daemons and control them from the parent or just daemonize the current process.  Besides this basic functionality, daemons offers many advanced features like exception  backtracing and logging (in case your ruby script crashes) and monitoring and automatic restarting of your processes if they crash.
-autorequire: daemons
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.0.10
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Thomas Uehlinger
+autorequire: daemons
+bindir: bin
+cert_chain: []
+
+date: 2008-03-21 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Daemons provides an easy way to wrap existing ruby scripts (for example a self-written server)  to be run as a daemon and to be controlled by simple start/stop/restart commands.  You can also call blocks as daemons and control them from the parent or just daemonize the current process.  Besides this basic functionality, daemons offers many advanced features like exception  backtracing and logging (in case your ruby script crashes) and monitoring and automatic restarting of your processes if they crash.
+email: th.uehlinger@gmx.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- Releases
+- TODO
 files: 
 - Rakefile
 - Releases
@@ -46,11 +41,6 @@ files:
 - lib/daemons/pidfile.rb
 - lib/daemons/pidmem.rb
 - lib/daemons.rb
-- test/call_as_daemon.rb
-- test/tc_main.rb
-- test/test1.rb
-- test/testapp.rb
-- test/tmp
 - examples/call
 - examples/call/call.rb
 - examples/call/call_monitor.rb
@@ -60,6 +50,7 @@ files:
 - examples/run/ctrl_crash.rb
 - examples/run/ctrl_exec.rb
 - examples/run/ctrl_exit.rb
+- examples/run/ctrl_keep_pid_files.rb
 - examples/run/ctrl_monitor.rb
 - examples/run/ctrl_multiple.rb
 - examples/run/ctrl_normal.rb
@@ -67,24 +58,38 @@ files:
 - examples/run/ctrl_optionparser.rb
 - examples/run/ctrl_proc.rb
 - examples/run/ctrl_proc.rb.output
+- examples/run/ctrl_proc_multiple.rb
+- examples/run/ctrl_proc_multiple.rb.output
 - examples/run/ctrl_proc_simple.rb
 - examples/run/myserver.rb
 - examples/run/myserver_crashing.rb
 - examples/run/myserver_crashing.rb.output
 - examples/run/myserver_exiting.rb
-test_files: 
-- test/tc_main.rb
+has_rdoc: true
+homepage: http://daemons.rubyforge.org
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: 
-- README
-- Releases
-- TODO
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: daemons
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A toolkit to create and control daemons in different ways
+test_files: []
 

data/test/call_as_daemon.rb

@@ -1,12 +0,0 @@
-SCRIPT_DIR = File.split(File.expand_path(__FILE__))[0]
-
-$LOAD_PATH << File.join(SCRIPT_DIR, '../lib')
-
-
-require 'pp'
-
-require 'daemons'
-
-print Daemonize::call_as_daemon(File.join(SCRIPT_DIR, 'tmp/call_as_daemon.log')) {
-  print "hello"
-}

data/test/tc_main.rb

@@ -1,24 +0,0 @@
-require 'test/unit'
-
-#CURRENT_DIR = File.split(File.expand_path(__FILE__))[0]
-
-#$LOAD_PATH << File.join(CURRENT_DIR, '../lib')
-
-
-require 'pp'
-
-require 'daemons'
-
-
-class TestMain < Test::Unit::TestCase
-
-  def test_argv_parsing
-  end
-  
-  def test_run
-    #Daemons.run(File.join(CURRENT_DIR,'testapp.rb'))
-  end
-  
-end
-
-

data/test/test1.rb

@@ -1,19 +0,0 @@
-
-SCRIPT_DIR = File.split(File.expand_path(__FILE__))[0]
-
-$LOAD_PATH << File.join(SCRIPT_DIR, '../lib')
-
-
-require 'pp'
-
-require 'daemons'
-
-
-options = {
-  :dir_mode => :script,
-  :dir => 'tmp',
-  :multiple => true
-}
-
-Daemons.run(File.join(SCRIPT_DIR,'testapp.rb'), options)
-

data/test/testapp.rb

@@ -1,11 +0,0 @@
-
-require 'pp'
-
-puts "Application ARGV:"
-pp ARGV
-
-
-loop do
-  sleep(5)
-end
-