feedupdater 0.1.0

data/lib/feed_updater/vendor/daemons/monitor.rb

@@ -0,0 +1,126 @@
+
+module Daemons
+
+  require 'daemons/daemonize'
+   
+  class Monitor
+    
+    def self.find(dir, app_name)
+      pid = PidFile.find_files(dir, app_name)[0]
+      
+      if pid
+        pid = PidFile.existing(pid)
+        
+        unless PidFile.running?(pid.pid)
+          pid.cleanup rescue nil
+          return
+        end
+        
+        monitor = self.allocate
+      
+        monitor.instance_variable_set(:@pid, pid)
+        
+        return monitor
+      end
+      
+      return nil
+    end
+    
+    
+    def initialize(an_app)
+      if an_app.pidfile_dir
+        @pid = PidFile.new(an_app.pidfile_dir, an_app.group.app_name + '_monitor', 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
+        
+        begin  
+          @pid.pid = Process.pid
+          
+  #         at_exit {
+  #           @pid.cleanup rescue nil
+  #         }
+          
+          # 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
+  #           exit
+  #         }
+          
+          watch(applications)
+        rescue ::Exception => e
+          begin
+            File.open(File.join(@pid.dir, @pid.progname + '.log'), 'a') {|f|
+              f.puts Time.now
+              f.puts e
+              f.puts e.backtrace.inspect
+            }
+          ensure 
+            @pid.cleanup rescue nil
+            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
+      Process.kill('TERM', @pid.pid) rescue nil
+      
+      # We try to remove the pid-files by ourselves, in case the application
+      # didn't clean it up.
+      @pid.cleanup rescue nil
+    end
+    
+  end
+  
+end

data/lib/feed_updater/vendor/daemons/pid.rb

@@ -0,0 +1,61 @@
+
+module Daemons
+
+  class Pid
+  
+    def Pid.running?(pid, additional = nil)
+      output = `ps ax`
+      return (/#{pid} / =~ output and (additional ? /#{additional}/ =~ output : true))
+    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  
+  
+  
+end

data/lib/feed_updater/vendor/daemons/pidfile.rb

@@ -0,0 +1,99 @@
+require 'daemons/pid'
+
+
+module Daemons
+
+  # === What is a Pid-File?
+  # A <i>Pid-File</i> is a file containing the <i>process identification number</i>
+  # (pid) that is stored in a well-defined location of the filesystem thus allowing other
+  # programs to find out the pid of a running script.
+  #
+  # Daemons needs the pid of the scripts that are currently running in the background
+  # to send them so called _signals_. Daemons uses the +TERM+ signal to tell the script
+  # to exit when you issue a +stop+ command.
+  #
+  # === How does a Pid-File look like?
+  #
+  # Pid-Files generated by Daemons have to following format:
+  #   <scriptname>.rb<number>.pid
+  # (Note that <tt><number></tt> is omitted if only one instance of the script can
+  # run at any time)
+  #
+  # Each file just contains one line with the pid as string (for example <tt>6432</tt>).
+  #  
+  # === Where are 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
+  #     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>
+  #
+  class PidFile < Pid
+
+    attr_reader :dir, :progname, :multiple, :number
+
+    def PidFile.find_files(dir, progname)
+      files = Dir[File.join(dir, "#{progname}*.pid")]
+      
+      files.delete_if {|f| not (File.file?(f) and File.readable?(f))}
+      
+      return files
+    end
+    
+    def PidFile.existing(path)
+      new_instance = PidFile.allocate
+      
+      new_instance.instance_variable_set(:@path, path)
+      
+      def new_instance.filename
+        return @path
+      end
+      
+      return new_instance
+    end
+    
+    def initialize(dir, progname, multiple = false)
+      @dir = File.expand_path(dir)
+      @progname = progname
+      @multiple = multiple
+      @number = 0 if multiple
+    end
+    
+    def filename
+      File.join(@dir, "#{@progname}#{ @number or '' }.pid")
+    end
+    
+    def exists?
+      File.exists? filename
+    end
+    
+    def pid=(p)
+      if multiple
+        while File.exists?(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
+      }
+    end
+
+    def cleanup
+      File.delete(filename)
+    end
+
+    def pid
+      File.open(filename) {|f|
+        return f.gets.to_i
+      }
+    end
+
+  end
+  
+end

data/lib/feed_updater/vendor/daemons/pidmem.rb

@@ -0,0 +1,10 @@
+require 'daemons/pid'
+
+
+module Daemons
+
+  class PidMem < Pid
+    attr_accessor :pid
+  end
+
+end

data/lib/feed_updater/vendor/daemons.rb

@@ -0,0 +1,274 @@
+require 'optparse'
+require 'optparse/time'
+
+
+require 'daemons/pidfile'  
+require 'daemons/cmdline'
+require 'daemons/exceptions'
+require 'daemons/monitor'
+
+
+require 'daemons/application'
+require 'daemons/application_group'
+require 'daemons/controller'
+
+
+# All functions and classes that Daemons provides reside in this module.
+#
+# Daemons is normally invoked by one of the following four ways:
+#
+# 1.  <tt>Daemons.run(script, options)</tt>:
+#     This is used in wrapper-scripts that are supposed to control other ruby scripts or
+#     external applications. Control is completely passed to the daemons library.
+#     Such wrapper script need to be invoked with command line options like 'start' or 'stop'
+#     to do anything useful.
+#
+# 2.  <tt>Daemons.run_proc(app_name, options) { (...) }</tt>:
+#     This is used in wrapper-scripts that are supposed to control a proc. 
+#     Control is completely passed to the daemons library.
+#     Such wrapper script need to be invoked with command line options like 'start' or 'stop'
+#     to do anything useful.
+#
+# 3.  <tt>Daemons.call(options) { block }</tt>:
+#     Execute the block in a new daemon. <tt>Daemons.call</tt> will return immediately
+#     after spawning the daemon with the new Application object as a return value.
+#
+# 4.  <tt>Daemons.daemonize(options)</tt>:
+#     Daemonize the currently runnig process, i.e. the calling process will become a daemon.
+#
+# == 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+?
+#
+# From a technical aspect of view, daemons does the following when creating a daemon:
+#
+# 1.  Forks a child (and exits the parent process, if needed)
+# 2.  Becomes a session leader (which detaches the program from
+#     the controlling terminal).
+# 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+).
+# 6.  Closes file descriptors (reopens +STDOUT+ and +STDERR+ to point to a logfile if
+#     possible).
+#
+# So what does this mean for your daemons:
+# - the current directory is '/'
+# - you cannot receive any input from the console (for example no +gets+)
+# - you cannot output anything from the daemons with +puts+/+print+ unless a logfile is used
+#
+# == How do PidFiles work? Where are they stored?
+#
+# Also, you are maybe interested in reading the documentation for the class PidFile.
+# There you can find out about how Daemons works internally and how and where the so
+# called <i>PidFiles</i> are stored.
+#
+module Daemons
+
+  VERSION = "0.4.4"
+  
+  require 'daemons/daemonize'
+  
+  
+  # Passes control to Daemons.
+  # This is used in wrapper-scripts that are supposed to control other ruby scripts or
+  # external applications. Control is completely passed to the daemons library.
+  # Such wrapper script should be invoked with command line options like 'start' or 'stop'
+  # to do anything useful.
+  #
+  # +script+::  This is the path to the script that should be run as a daemon.
+  #             Please note that Daemons runs this script with <tt>load <script></tt>.
+  #             Also note that Daemons cannot detect the directory in which the controlling
+  #             script resides, so this has to be either an absolute path or you have to run
+  #             the controlling script from the appropriate directory.
+  #
+  # +options+:: A hash that may contain one or more of the options listed below
+  #
+  # === Options:
+  # <tt>:app_name</tt>::  The name of the application. This will be
+  #                       used to contruct the name of the pid files
+  #                       and log files. Defaults to the basename of
+  #                       the script.
+  # <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>/var/run</tt> is used as the pid file directory)
+  #
+  # <tt>:dir</tt>::       Used in combination with <tt>:dir_mode</tt> (description above)
+  # <tt>:multiple</tt>::  Specifies whether multiple instances of the same script are allowed to run at the
+  #                       same time
+  # <tt>:ontop</tt>::     When given, stay on top, i.e. do not daemonize the application 
+  #                       (but the pid-file and other things are written as usual)
+  # <tt>:mode</tt>::      <tt>:load</tt> Load the script with <tt>Kernel.load</tt>;
+  #                       <tt>:exec</tt> Execute the script file with <tt>Kernel.exec</tt>
+  # <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
+  # -----
+  # 
+  # === Example:
+  #   options = {
+  #     :app_name   => "my_app",
+  #     :dir_mode   => :script,
+  #     :dir        => 'pids',
+  #     :multiple   => true,
+  #     :ontop      => true,
+  #     :mode       => :exec,
+  #     :backtrace  => true,
+  #     :monitor    => true,
+  #     :script     => "path/to/script.rb"
+  #   }
+  #
+  #   Daemons.run(File.join(File.split(__FILE__)[0], 'myscript.rb'), options)
+  #
+  def run(script, options = {})
+    options[:script] = script
+    @controller = Controller.new(options, ARGV)
+    
+    @controller.catch_exceptions {
+      @controller.run
+    }
+    
+    # I don't think anybody will ever use @group, as this location should not be reached under non-error conditions
+    @group = @controller.group
+  end
+  module_function :run
+  
+  
+  # Passes control to Daemons.
+  # This function does the same as Daemons.run except that not a script but a proc
+  # will be run as a daemon while this script provides command line options like 'start' or 'stop'
+  # and the whole pid-file management to control the proc.
+  #
+  # +app_name+::  The name of the application. This will be
+  #               used to contruct the name of the pid files
+  #               and log files. Defaults to the basename of
+  #               the script.
+  # 
+  # +options+::   A hash that may contain one or more of the options listed in the documentation for Daemons.run
+  #
+  # A block must be given to this function. The block will be used as the :proc entry in the options hash.
+  # -----
+  # 
+  # === Example:
+  #
+  #   Daemons.run_proc('myproc.rb') do
+  #     loop do
+  #       accept_connection()
+  #       read_request()
+  #       send_response()
+  #       close_connection()
+  #     end
+  #   end
+  #
+  def run_proc(app_name, options = {}, &block)
+    options[:app_name] = app_name
+    options[:mode] = :proc
+    options[:proc] = block
+    
+    if [nil, :script].include? options[:dir_mode]
+      options[:dir_mode] = :normal
+      options[:dir] = File.split(__FILE__)[0]
+    end
+    
+    @controller = Controller.new(options, ARGV)
+    
+    @controller.catch_exceptions {
+      @controller.run
+    }
+    
+    # I don't think anybody will ever use @group, as this location should not be reached under non-error conditions
+    @group = @controller.group
+  end
+  module_function :run_proc
+  
+  
+  # Execute the block in a new daemon. <tt>Daemons.call</tt> will return immediately
+  # after spawning the daemon with the new Application object as a return value.
+  #
+  # +options+:: A hash that may contain one or more of the options listed below
+  #
+  # +block+::   The block to call in the daemon.
+  #
+  # === Options:
+  # <tt>:multiple</tt>::  Specifies whether multiple instances of the same script are allowed to run at the
+  #                       same time
+  # <tt>:ontop</tt>::     When given, stay on top, i.e. do not daemonize the application 
+  # <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
+  # -----
+  # 
+  # === Example:
+  #   options = {
+  #     :backtrace  => true,
+  #     :monitor    => true,
+  #     :ontop      => true
+  #   }
+  #
+  #   Daemons.call(options) begin
+  #     # Server loop:
+  #     loop {
+  #       conn = accept_conn()
+  #       serve(conn)
+  #     }
+  #   end
+  #
+  def call(options = {}, &block)
+    unless block_given?
+      raise "Daemons.call: no block given"
+    end
+    
+    options[:proc] = block
+    options[:mode] = :proc
+    
+    @group ||= ApplicationGroup.new('proc', options)
+    
+    new_app = @group.new_application(options)
+    new_app.start
+
+    return new_app
+  end
+  module_function :call
+  
+  
+  # Daemonize the currently runnig process, i.e. the calling process will become a daemon.
+  #
+  # +options+:: A hash that may contain one or more of the options listed below
+  #
+  # === Options:
+  # <tt>:ontop</tt>::     When given, stay on top, i.e. do not daemonize the application 
+  # <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
+  # -----
+  # 
+  # === Example:
+  #   options = {
+  #     :backtrace  => true,
+  #     :ontop      => true
+  #   }
+  #
+  #   Daemons.daemonize(options)
+  #
+  #   # Server loop:
+  #   loop {
+  #     conn = accept_conn()
+  #     serve(conn)
+  #   }
+  #
+  def daemonize(options = {})
+    @group ||= ApplicationGroup.new('self', options)
+    
+    @group.new_application(:mode => :none).start
+    
+  end
+  module_function :daemonize
+  
+  # Return the internal ApplicationGroup instance.
+  def group; @group; end
+  module_function :group
+  
+  # Return the internal Controller instance.
+  def controller; @controller; end
+  module_function :controller
+end 

data/lib/feed_updater/version.rb

@@ -0,0 +1,9 @@
+module FeedTools
+  module FEED_UPDATER_VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end