fire_and_forget 0.1.2 → 0.2.0

data/vendor/daemons-1.1.0/Rakefile

@@ -0,0 +1,88 @@
+require 'rubygems'
+#Gem::manage_gems
+
+require 'rake/gempackagetask'
+#require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/rdoctask'
+
+$LOAD_PATH << './lib'
+require 'daemons'
+
+
+PKG_NAME = "daemons"
+
+PKG_FILES = FileList[
+  "Rakefile", "Releases", "TODO", "README", "LICENSE",
+  "setup.rb",
+  "lib/**/*.rb",
+  #"test/**/*",
+  "examples/**/*"
+]
+#PKG_FILES.exclude(%r(^test/tmp/.+))
+PKG_FILES.exclude(%r(\.pid$))
+PKG_FILES.exclude(%r(\.log$))
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = Daemons::VERSION
+  s.author = "Thomas Uehlinger"
+  s.email = "th.uehlinger@gmx.ch"
+  s.rubyforge_project = "daemons"
+  s.homepage = "http://daemons.rubyforge.org"
+  s.platform  = Gem::Platform::RUBY
+  s.summary = "A toolkit to create and control daemons in different ways"
+  s.description = <<-EOF
+    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.
+  EOF
+    
+  #s.files = FileList["{test,lib}/**/*"].exclude("rdoc").to_a
+  s.files = PKG_FILES
+  s.require_path = "lib"
+  s.autorequire = "daemons"
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "Releases", "TODO"]
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end
+
+
+#Rake::PackageTask.new("package") do |p|
+#  p.name = PKG_NAME
+#  p.version = Daemons::VERSION
+#  p.need_tar = true
+#  p.need_zip = true
+#  p.package_files = PKG_FILES
+#end
+
+ 
+task :default => [:package]
+
+desc 'Show information about the gem.'
+task :debug_gem do
+  puts spec.to_ruby
+end
+
+task :upload do
+  sh "scp -r html/* uehli@rubyforge.org:/var/www/gforge-projects/daemons"
+end
+
+
+desc "Create the RDOC html files"
+rd = Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.title    = "Daemons"
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
+  rdoc.rdoc_files.include('README', 'TODO', 'Releases')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}

data/vendor/daemons-1.1.0/Releases

@@ -0,0 +1,152 @@
+= Daemons Release History
+
+== Release 1.1.0: June 20, 2010
+
+* Honour the options[:app_name] in Daemons.daemonize (thanks to Ryan Tecco).
+* Included a new option :stop_proc to specify a proc that will be called when a 
+  daemonized process receives a request to stop (thanks to Dave Dupre).
+* Only delete the pidfile if the current pid is the original pid (ghazel).
+* Start when restart but no application running (pcreux).
+* Silently continue if there is no pidfile (ghazel).
+* We now per default wait for processes to stop and
+  kill them automatically it if they do not stop within a given time 
+  (force_kill_waittime). Use the option --no_wait to not wait for processes to 
+  stop.
+* Set log files mode to 0644 (mikehale).
+* Set pid file permissions to 0644 (mikehale).
+* Added ability to change process uid/gid (mikehale).
+* Fix for: If you happen to start a daemon from a process that has open file 
+  descriptors these will stay open. As it is daemonize.rb only closes ruby IO 
+  objects (thanks to Han Holl).
+* New reload command (SIGHUP) (thanks to Michael Schuerig).
+
+== Release 1.0.10: March 21, 2008
+
+* 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).
+
+== Release 1.0.8: September 24, 2007
+
+* new Pid.running? function. Checking whether a process exists by sending 
+  signal '0' (thanks to Dru Nelson).
+
+== Release 1.0.7: July 7, 2007
+
+* Patch to fix wrong ARGV when using :exec (in def start_exec: 
+  Kernel.exec(script(), *(@app_argv || []))) (thanks to Alex McGuire).
+
+== Release 1.0.6: Mai 8, 2007
+
+* New option to pass an ARGV-style array to run and run_proc (thanks to Marc Evans).
+* Additional patches for '/var/log' (thanks to Marc Evans).
+
+== Release 1.0.5: February 24, 2007
+
+* Applied patch that makes daemons to use '/var/log' as logfile 
+  directory if you use :dir_mode = :system (thanks to Han Holl).
+* Daemons should now work with Ruby 1.9 (at least the basic features).
+
+== Release 1.0.4: January 17, 2007
+
+* Document the :log_output option (thanks to Andrew Kuklewicz).
+* Set STDOUT.sync = true when redirecting to a logfile (thanks to Andrew Kuklewicz).
+* Should now run also correctly when there is no working 'ps ax' on the system 
+  (thanks to Daniel Kehoe).
+
+== Release 1.0.3: November 1, 2006
+
+* Set the app_name correctly also for the monitor process (thanks to Ilya Novoselov).
+
+== 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)
+
+== Release 1.0.0: August 29, 2006
+
+* Fix the parsing of the 'ps ax' system call. (thanks to Garance Alistair Drosehn)
+
+== Release 0.4.4: February 14, 2006
+
+* Several fixes that allow us to use the Daemons::Controller 
+  with a proc instead of wrapping a script file. This gives us all the
+  PID file management, monitoring, command line options, etc. without having
+  to specify a path to our script which can be tricky, especially when using
+  RubyGems. (thanks to John-Mason Shackelford)
+
+== Release 0.4.3: November 29, 2005
+
+* New Option: You can specify the name of the application with :app_name
+  on calling Daemons.run. This will be used to contruct the name of the pid files
+  and log files. Defaults to the basename of the script. (thanks to Stephen R. Veit)
+
+* Bugfix: Handle the case where no controller options are given when calling Daemons, 
+  just options after "--". (thanks to Stephen R. Veit)
+
+
+== Release 0.4.2: November 15, 2005
+
+* Bugfix for problem with :normal pid-file directory mode (pid.rb), fixed (thanks to Stephen R. Veit)
+
+
+== Release 0.4.1: September 11, 2005
+
+* Bugfix for 'run' command line mode: didn't work anymore in 0.4.0, fixed
+
+
+== Release 0.4.0: July 30, 2005
+
+* Two completely new operation modes:
+  1. Call a block as a daemon (<tt>Daemons.call { my_daemon_code }</tt>)
+     and control it from the parent process.
+  2. Daemonize the currently running process (<tt>Daemons.daemonize</tt>)
+  plus the already existing mode to control your scripts (<tt>Daemons.run("script.rb")</tt>)
+* Improved documentation (for example "How does the daemonization process work?")
+* Improved "simulation mode" (<tt>:ontop</tt> option)
+* Some minor bugfixes
+
+
+== Release 0.3.0: April 21, 2005
+
+* New monitor functionality: automatic restarting of your applications if they crash
+* 'restart' command fixed
+* '--force' command modifier (please refer to the documentation)
+* Some more bugfixes and improvements
+
+
+== Release 0.2.1: Mar 21, 2005
+
+* Bugfix for a problem with the 'status' command
+
+
+== Release 0.2.0: Mar 21, 2005
+
+* Exception backtrace functionality added
+* Exec functionality added
+* More examples added
+* New commands: status, zap
+
+
+== Release 0.0.1: Feb 8, 2005
+
+* Initial release

data/vendor/daemons-1.1.0/TODO

@@ -0,0 +1,2 @@
+* put TODOS here
+

data/vendor/daemons-1.1.0/lib/daemons/application.rb

@@ -0,0 +1,468 @@
+require 'daemons/pidfile'
+require 'daemons/pidmem'
+require 'daemons/change_privilege'
+
+require 'timeout'
+
+
+module Daemons
+
+  class Application
+  
+    attr_accessor :app_argv
+    attr_accessor :controller_argv
+    
+    # the Pid instance belonging to this application
+    attr_reader :pid
+    
+    # the ApplicationGroup the application belongs to
+    attr_reader :group
+    
+    # my private options
+    attr_reader :options
+    
+    
+    SIGNAL = (RUBY_PLATFORM =~ /win32/ ? 'KILL' : 'TERM')
+    
+    
+    def initialize(group, add_options = {}, pid = nil)
+      @group = group
+      @options = group.options.dup
+      @options.update(add_options)
+      
+      @dir_mode = @dir = @script = nil
+      
+      @force_kill_waittime = @options[:force_kill_waittime] || 20
+      
+      unless @pid = pid
+        if @options[:no_pidfiles]
+          @pid = PidMem.new
+        elsif dir = pidfile_dir
+          @pid = PidFile.new(dir, @group.app_name, @group.multiple)
+        else
+          @pid = PidMem.new
+        end
+      end
+    end
+    
+    def change_privilege
+      user = options[:user]
+      group = options[:group]
+      CurrentProcess.change_privilege(user, group) if user
+    end
+    
+    def script
+      @script || @group.script
+    end
+    
+    def pidfile_dir
+      Pid.dir(@dir_mode || @group.dir_mode, @dir || @group.dir, @script || @group.script)
+    end
+    
+    def logdir
+      logdir = options[:log_dir]
+      unless logdir
+        logdir = options[:dir_mode] == :system ? '/var/log' : pidfile_dir
+      end
+      logdir
+    end
+    
+    def output_logfile
+      (options[:log_output] && logdir) ? File.join(logdir, @group.app_name + '.output') : nil
+    end
+    
+    def logfile
+      logdir ? File.join(logdir, @group.app_name + '.log') : nil
+    end
+    
+    # this function is only used to daemonize the currently running process (Daemons.daemonize)
+    def start_none
+      unless options[:ontop]
+        Daemonize.daemonize(nil, @group.app_name) #(logfile)
+      else
+        Daemonize.simulate
+      end
+      
+      @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>
+      # in your application!
+      #
+      at_exit {
+        begin; @pid.cleanup; rescue ::Exception; end
+        
+        # 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
+          begin; exception_log(); rescue ::Exception; end
+        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(SIGNAL) {
+        begin; @pid.cleanup; rescue ::Exception; end
+        $daemons_sigterm = true
+        
+        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
+        Daemonize.simulate(output_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(' ')      
+      # haven't tested yet if this is really passed to the exec'd process...
+      
+      started()
+      Kernel.exec(script(), *(@app_argv || []))
+      #Kernel.exec(script(), *ARGV)
+    end
+    
+    def start_load
+      unless options[:ontop]
+        Daemonize.daemonize(output_logfile, @group.app_name)
+      else
+        Daemonize.simulate(output_logfile)
+      end
+      
+      @pid.pid = Process.pid
+      
+      
+      # We need this to remove the pid-file if the applications exits by itself.
+      # Note that <tt>at_exit</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 {
+        begin; @pid.cleanup; rescue ::Exception; end
+        
+        # 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
+          begin; exception_log(); rescue ::Exception; end
+        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'.
+      #
+      $daemons_stop_proc = options[:stop_proc]
+      trap(SIGNAL) {
+        begin
+        if $daemons_stop_proc
+          $daemons_stop_proc.call
+        end
+        rescue ::Exception
+        end
+        
+        begin; @pid.cleanup; rescue ::Exception; end
+        $daemons_sigterm = true
+        
+        if options[:hard_exit]
+          exit!
+        else
+          exit
+        end
+      }
+      
+      # Now we really start the script...
+      $DAEMONS_ARGV = @controller_argv
+      ENV['DAEMONS_ARGV'] = @controller_argv.join(' ')
+      
+      ARGV.clear
+      ARGV.concat @app_argv if @app_argv
+      
+      started()
+      # TODO: begin - rescue - end around this and exception logging
+      load script()
+    end
+    
+    def start_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 {
+          begin; @pid.cleanup; rescue ::Exception; end
+
+          # 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
+            begin; exception_log(); rescue ::Exception; end
+          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'.
+        #
+        $daemons_stop_proc = options[:stop_proc]
+        trap(SIGNAL) {
+          begin
+          if $daemons_stop_proc
+            $daemons_stop_proc.call
+          end
+          rescue ::Exception
+          end
+          
+          begin; @pid.cleanup; rescue ::Exception; end
+          $daemons_sigterm = true
+
+          if options[:hard_exit]
+            exit!
+          else
+            exit
+          end
+        }
+        
+        p.call()
+      end
+      
+      unless options[:ontop]
+        @pid.pid = 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??
+#         Thread.new(&options[:proc])
+
+# 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
+      
+      started()
+    end
+    
+    
+    def start
+      change_privilege
+      @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
+        when :load
+          start_load
+        when :proc
+          start_proc
+        else
+          start_load
+      end
+    end
+    
+    def started
+      if pid = @pid.pid
+        puts "#{self.group.app_name}: process with pid #{pid} started."
+        STDOUT.flush
+      end
+    end
+    
+    
+#     def run
+#       if @group.controller.options[:exec]
+#         run_via_exec()
+#       else
+#         run_via_load()
+#       end
+#     end
+#      
+#     def run_via_exec
+#       
+#     end
+#     
+#     def run_via_load
+#       
+#     end
+
+	def reload
+      Process.kill('HUP', @pid.pid)
+    rescue
+      # ignore
+    end
+
+    # This is a nice little function for debugging purposes:
+    # In case a multi-threaded ruby script exits due to an uncaught exception
+    # it may be difficult to find out where the exception came from because
+    # one cannot catch exceptions that are thrown in threads other than the main
+    # thread.
+    #
+    # This function searches for all exceptions in memory and outputs them to STDERR
+    # (if it is connected) and to a log file in the pid-file directory.
+    #
+    def exception_log
+      return unless logfile
+      
+      require 'logger'
+      
+      l_file = Logger.new(logfile)
+      
+      # 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|
+        if ::Exception === o
+          l_file.error o
+        end
+      }
+      
+      l_file.close
+    end
+    
+    
+    def stop(no_wait = false)
+      if not running?
+        self.zap
+        return
+      end
+      
+      pid = @pid.pid
+      
+      # Catch errors when trying to kill a process that doesn't
+      # exist. This happens when the process quits and hasn't been
+      # restarted by the monitor yet. By catching the error, we allow the
+      # pid file clean-up to occur.
+      begin
+        Process.kill(SIGNAL, pid)
+      rescue Errno::ESRCH => e
+        puts "#{e} #{pid}"
+        puts "deleting pid-file."
+      end
+      
+      if not no_wait
+        if @force_kill_waittime > 0
+          puts "#{self.group.app_name}: trying to stop process with pid #{pid}..."
+          STDOUT.flush
+          
+          begin
+            Timeout::timeout(@force_kill_waittime) {
+              while @pid.running?
+                sleep(0.2)
+              end
+            }
+          rescue Timeout::Error
+            puts "#{self.group.app_name}: process with pid #{pid} won't stop, we forcefully kill it..."
+            STDOUT.flush
+            
+            begin
+              Process.kill('KILL', pid)
+            rescue Errno::ESRCH
+            end
+            
+            begin
+              Timeout::timeout(20) {
+                while @pid.running?
+                  sleep(1)
+                end
+              }
+            rescue Timeout::Error
+              puts "#{self.group.app_name}: unable to forcefully kill process with pid #{pid}."
+              STDOUT.flush
+            end
+          end
+        end
+        
+        
+      end
+      
+      sleep(0.1)
+      unless @pid.running?
+        # We try to remove the pid-files by ourselves, in case the application
+        # didn't clean it up.
+        begin; @pid.cleanup; rescue ::Exception; end
+        
+        puts "#{self.group.app_name}: process with pid #{pid} successfully stopped."
+        STDOUT.flush
+      end
+      
+    end
+    
+    def zap
+      @pid.cleanup
+    end
+    
+    def zap!
+      begin; @pid.cleanup; rescue ::Exception; end
+    end
+    
+    def show_status
+      running = self.running?
+      
+      puts "#{self.group.app_name}: #{running ? '' : 'not '}running#{(running and @pid.exist?) ? ' [pid ' + @pid.pid.to_s + ']' : ''}#{(@pid.exist? and not running) ? ' (but pid-file exists: ' + @pid.pid.to_s + ')' : ''}"
+    end
+    
+    # This function implements a (probably too simle) method to detect
+    # whether the program with the pid found in the pid-file is still running.
+    # It just searches for the pid in the output of <tt>ps ax</tt>, which
+    # is probably not a good idea in some cases.
+    # Alternatives would be to use a direct access method the unix process control
+    # system.
+    #
+    def running?
+      if @pid.exist?
+        return Pid.running?(@pid.pid)
+      end
+      
+      return false
+    end
+  end
+  
+end