mikehale-daemons 1.0.12.1

data/lib/daemons/daemonize.rb

@@ -0,0 +1,263 @@
+#--
+###############################################################################
+# 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
+    tryagain = true
+
+    while tryagain
+      tryagain = false
+      begin
+        if pid = fork
+          return pid
+        end
+      rescue Errno::EWOULDBLOCK
+        sleep 5
+        tryagain = true
+      end
+    end
+  end
+  module_function :safefork
+  
+  
+  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
+    File.umask 0000 # Insure sensible umask
+
+    # 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
+
+    # Free file descriptors and
+    # point them somewhere sensible
+    # STDOUT/STDERR should go to a logfile
+    
+    begin; STDIN.reopen "/dev/null"; rescue ::Exception; end       
+  end
+  module_function :simulate
+  
+  
+  def call_as_daemon(block, logfile_name = nil, app_name = nil)
+    rd, wr = IO.pipe
+    
+    if tmppid = safefork
+      # parent
+      wr.close
+      pid = rd.read.to_i
+      rd.close
+      
+      Process.waitpid(tmppid)
+      
+      return pid
+    else
+      # child
+      
+      rd.close
+      
+      # Detach from the controlling terminal
+      unless sess_id = Process.setsid
+        raise Daemons.RuntimeException.new('cannot detach from controlling terminal')
+      end
+  
+      # Prevent the possibility of acquiring a controlling terminal
+      #if oldmode.zero?
+        trap 'SIGHUP', 'IGNORE'
+        exit if pid = safefork
+      #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
+  
+      # 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
+  
+      redirect_io(logfile_name)  
+    
+      block.call
+      
+      exit
+    end
+  end
+  module_function :call_as_daemon
+  
+  
+  # This method causes the current running process to become 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
+
+    # Detach from the controlling terminal
+    unless sess_id = Process.setsid
+      raise Daemons.RuntimeException.new('cannot detach from controlling terminal')
+    end
+
+    # Prevent the possibility of acquiring a controlling terminal
+    #if oldmode.zero?
+      trap 'SIGHUP', 'IGNORE'
+      exit if pid = safefork
+    #end
+
+    $0 = app_name if app_name
+    
+    Dir.chdir "/"   # Release old working directory
+    File.umask 0000 # Insure sensible umask
+
+    # 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
+
+    redirect_io(logfile_name)
+    
+    #return oldmode ? sess_id : 0   # Return value is mostly irrelevant
+    return sess_id
+  end
+  module_function :daemonize
+  
+  
+  # Free 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       
+     
+    if logfile_name
+      begin
+        STDOUT.reopen logfile_name, "a" 
+        STDOUT.sync = true
+      rescue ::Exception
+        begin; STDOUT.reopen "/dev/null"; rescue ::Exception; end
+      end
+    else
+      begin; STDOUT.reopen "/dev/null"; rescue ::Exception; end
+    end
+    
+    begin; STDERR.reopen STDOUT; rescue ::Exception; end
+    STDERR.sync = true
+  end
+  module_function :redirect_io
+  
+end

data/lib/daemons/etc_extension.rb

@@ -0,0 +1,12 @@
+require 'etc'
+
+Etc.instance_eval do
+  def groupname(gid)
+    Etc.group {|e| return e.name if gid == e.gid }
+    nil
+  end
+  def username(uid)
+    Etc.passwd {|e| return e.name if uid == e.uid }
+    nil
+  end
+end

data/lib/daemons/exceptions.rb

@@ -0,0 +1,28 @@
+
+module Daemons
+
+  class Exception < ::RuntimeError
+  end
+  
+  class RuntimeException < Exception
+  end
+  
+  class CmdException < Exception
+  end
+  
+  class Error < Exception
+  end
+  
+  class SystemError < Error
+  
+    attr_reader :system_error
+    
+    def initialize(msg, system_error)
+      super(msg)
+      
+      @system_error = system_error
+    end
+    
+  end
+  
+end

data/lib/daemons/monitor.rb

@@ -0,0 +1,127 @@
+
+module Daemons
+
+  require 'daemons/daemonize'
+   
+  class Monitor
+    
+    def self.find(dir, app_name)
+      pid = PidFile.find_files(dir, app_name, false)[0]
+      
+      if pid
+        pid = PidFile.existing(pid)
+        
+        unless PidFile.running?(pid.pid)
+          begin; pid.cleanup; rescue ::Exception; end
+          return
+        end
+        
+        monitor = self.allocate
+      
+        monitor.instance_variable_set(:@pid, pid)
+        
+        return monitor
+      end
+      
+      return nil
+    end
+    
+    
+    def initialize(an_app)
+      @app = an_app
+      @app_name = an_app.group.app_name + '_monitor'
+      
+      if an_app.pidfile_dir
+        @pid = PidFile.new(an_app.pidfile_dir, @app_name, false)
+      else
+        @pid = PidMem.new
+      end
+    end
+    
+    def watch(applications)
+      sleep(30)
+      
+      loop do
+        applications.each {|a|
+          sleep(10)
+          
+          unless a.running?
+            a.zap!
+            
+            Process.detach(fork { a.start })
+            
+            sleep(10)
+          end
+        }
+        
+        sleep(30)
+      end
+    end
+    private :watch
+    
+    
+    def start_with_pidfile(applications)
+      fork do
+        Daemonize.daemonize(nil, @app_name)
+        
+        begin  
+          @pid.pid = Process.pid
+          
+  #         at_exit {
+  # begin; @pid.cleanup; rescue ::Exception; 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') {
+  # begin; @pid.cleanup; rescue ::Exception; end
+  #           exit
+  #         }
+          
+          watch(applications)
+        rescue ::Exception => e
+          begin
+            File.open(@app.logfile, 'a') {|f|
+              f.puts Time.now
+              f.puts e
+              f.puts e.backtrace.inspect
+            }
+          ensure 
+            begin; @pid.cleanup; rescue ::Exception; end
+            exit!
+          end
+        end
+      end
+    end
+    private :start_with_pidfile
+    
+    def start_without_pidfile(applications)
+      Thread.new { watch(applications) }
+    end
+    private :start_without_pidfile
+    
+    
+    def start(applications)
+      return if applications.empty?
+      
+      if @pid.kind_of?(PidFile)
+        start_with_pidfile(applications)
+      else
+        start_without_pidfile(applications)
+      end
+    end
+    
+    
+    def stop
+      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.
+      begin; @pid.cleanup; rescue ::Exception; end
+    end
+    
+  end 
+end

data/lib/daemons/pid.rb

@@ -0,0 +1,101 @@
+require 'open3'
+
+
+module Daemons
+
+  class Pid
+  
+    def Pid.running?(pid)
+      # Check if process is in existence
+      # The simplest way to do this is to send signal '0'
+      # (which is a single system call) that doesn't actually
+      # send a signal
+      begin
+        Process.kill(0, pid)
+        return true
+      rescue Errno::ESRCH
+        return false
+      rescue ::Exception   # for example on EPERM (process exists but does not belong to us)
+        return true
+      #rescue Errno::EPERM
+      #  return false
+      end
+    end
+    
+  #  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_in, ps_out, ps_err = Open3.popen3('ps ax') # the correct syntax is without a dash (-) !
+  #    
+  #    return true unless ps_out.gets
+  #    
+  #    begin
+  #      ps_out.each { |psline|
+  #        next unless psline =~ match_pid
+  #        got_match = true
+  #        got_match = false if additional and psline !~ /#{additional}/
+  #        break
+  #      }
+  #    ensure
+  #      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
+  #    # `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 exist?
+      true
+    end
+    
+  end  
+  
+  
+end