daemon-kit 0.1.7 → 0.1.7.4

data/lib/daemon_kit/config.rb

@@ -20,6 +20,7 @@ module DaemonKit
 
       # Load the +config+.yml file from DAEMON_ROOT/config
       def load( config )
+        config = config.to_s
         config += '.yml' unless config =~ /\.yml$/
 
         path = File.join( DAEMON_ROOT, 'config', config )

data/lib/daemon_kit/console_daemon.rb

@@ -0,0 +1,2 @@
+# Load and configure our daemon process, without daemonizing
+DaemonKit::Application.running!

data/lib/daemon_kit/core_ext.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/core_ext/string'

data/lib/daemon_kit/core_ext/string.rb

@@ -0,0 +1,22 @@
+require 'pathname'
+
+class String
+
+  # Assuming the string is a file or path name, convert it into an
+  # absolute path.
+  def to_absolute_path
+    # Pathname is incompatible with Windows, but Windows doesn't have
+    # real symlinks so File.expand_path is safe.
+    if RUBY_PLATFORM =~ /(:?mswin|mingw)/
+      File.expand_path( self )
+
+      # Otherwise use Pathname#realpath which respects symlinks.
+    else
+      begin
+        File.expand_path( Pathname.new( self ).realpath.to_s )
+      rescue Errno::ENOENT
+        File.expand_path( Pathname.new( self ).cleanpath.to_s )
+      end
+    end
+  end
+end

data/lib/daemon_kit/deployment/capistrano.rb

@@ -305,18 +305,15 @@ namespace :deploy do
   end
 
   desc <<-DESC
-    Restarts your application. This works by calling the bin/:application \
-    script under the current path with 'restart'
+    Restarts your application. This works by calling 'stop' task, \
+    followed by the 'start' task.
 
-    By default, this will be invoked via sudo as the `app' user. If \
-    you wish to run it as a different user, set the :runner variable to \
-    that user. If you are in an environment where you can't use sudo, set \
-    the :use_sudo variable to false:
-
-      set :use_sudo, false
+    See the descriptions for the 'start' and 'stop' tasks for any \
+    additional info.
   DESC
   task :restart, :except => { :no_release => true } do
-    try_runner "/usr/bin/env DAEMON_ENV=#{fetch(:daemon_env)} #{current_path}/bin/#{application} restart"
+    stop
+    start
   end
 
   namespace :rollback do

data/lib/daemon_kit/error_handlers/mail.rb

@@ -1,33 +1,66 @@
+require DaemonKit.framework_root + '/vendor/tmail'
 require 'net/smtp'
 
 module DaemonKit
   module ErrorHandlers
-    # Send an email notification of the exception via SMTP
+    # Send an email notification of the exception via SMTP.
     class Mail < Base
-      
+
       # SMTP hostname
       @host = 'localhost'
-      attr_accessor :host
-      
+
+      # SMTP port
+      @port = 25
+
       # Recipients of the notification
       @recipients = []
-      attr_accessor :recipients
 
       # Subject prefix
       @prefix = '[DAEMON-KIT]'
-      attr_accessor :prefix
 
       # Sender address
       @sender = 'daemon-kit'
-      attr_accessor :sender
+
+      # SMTP username
+      @username = nil
+
+      # SMTP password
+      @password = nil
+
+      # Authentication mechanism (:plain, :login, or :cram_md5)
+      @authentication = nil
+
+      # Use TLS?
+      @tls = false
+
+      # Domain used when talking to SMTP server
+      @domain = 'localhost.localdomain'
+
+      class << self
+        attr_accessor :host, :port, :recipients, :prefix, :sender, :username,
+        :password, :authentication, :tls, :domain
+      end
+
+      [ :host, :port, :recipients, :prefix, :sender, :username, :password,
+        :authentication, :tls, :domain ].each do |cm|
+        class_eval(<<-EOM, __FILE__, __LINE__)
+          def #{cm}=( val )
+            self.class.#{cm} = val
+          end
+        EOM
+      end
 
       def handle_exception( exception )
-        email = <<EOF
-To: #{self.recipients.map { |r| '<' + r + '>' }.join(', ')}
-From: <#{self.sender}>
-Subject: #{self.prefix} #{exception.message}
-Date: #{Time.now}
 
+        mail = TMail::Mail.new
+        mail.to = self.class.recipients
+        mail.from = self.class.sender
+        mail.subject = "#{self.class.prefix} #{exception.message}"
+        mail.set_content_type 'text', 'plain'
+        mail.mime_version = '1.0'
+        mail.date = Time.now
+
+        mail.body = <<EOF
 DaemonKit caught an exception inside #{DaemonKit.configuration.daemon_name}.
 
 Message: #{exception.message}
@@ -37,10 +70,14 @@ Backtrace:
 Environment: #{ENV.inspect}
 EOF
         begin
-          Net::SMTP.start( self.host ) do |smtp|
-            smtp.send_message( email, self.sender, self.recipients )
+          smtp = Net::SMTP.new( self.class.host, self.class.port )
+          smtp.enable_starttls_auto if self.class.tls && smtp.respond_to?(:enable_starttls_auto)
+          smtp.start( self.class.domain, self.class.username, self.class.password,
+                      self.class.authentication ) do |smtp|
+            smtp.sendmail( mail.to_s, mail.from, mail.to )
           end
-        rescue
+        rescue => e
+          DaemonKit.logger.error "Failed to send exception mail: #{e.message}" if DaemonKit.logger
         end
       end
     end

data/lib/daemon_kit/initializer.rb

@@ -3,21 +3,21 @@ require 'pathname'
 
 DAEMON_ENV = (ENV['DAEMON_ENV'] || 'development').dup unless defined?(DAEMON_ENV)
 
-$:.unshift File.dirname(__FILE__) + '/..'
+# Absolute paths to the daemon_kit libraries added to $:
+incdir = ( File.dirname(__FILE__) + '/..' )
+absincdir = if RUBY_PLATFORM =~ /(:?mswin|mingw)/
+              File.expand_path( incdir )
+            else
+              File.expand_path( Pathname.new( incdir ).realpath.to_s )
+            end
+$:.unshift absincdir unless $:.include?( absincdir )
+
 require 'daemon_kit'
 
 module DaemonKit
 
   class << self
 
-    def logger
-      @logger
-    end
-
-    def logger=( logger )
-      @logger = logger
-    end
-
     def configuration
       @configuration
     end
@@ -26,17 +26,18 @@ module DaemonKit
       @configuration = configuration
     end
 
-    def trap( *args, &block )
-      self.configuration.trap( *args, &block )
+    def arguments
+      @arguments
     end
 
-    def framework_root
-      File.join( File.dirname(__FILE__), '..', '..' )
+    def arguments=( args )
+      @arguments = args
     end
 
-    def root
-      DAEMON_ROOT
+    def trap( *args, &block )
+      self.configuration.trap( *args, &block )
     end
+
   end
 
 
@@ -46,7 +47,9 @@ module DaemonKit
 
     attr_reader :configuration
 
-    def self.run( configuration = Configuration.new )
+    def self.run
+      configuration = DaemonKit.configuration || Configuration.new
+
       yield configuration if block_given?
       initializer = new configuration
       initializer.before_daemonize
@@ -59,7 +62,7 @@ module DaemonKit
     end
 
     def self.shutdown
-      DaemonKit.logger.warn "Shutting down"
+      DaemonKit.logger.warn "Shutting down #{DaemonKit.configuration.daemon_name}"
       exit
     end
 
@@ -83,6 +86,10 @@ module DaemonKit
 
       include_core_lib
       load_postdaemonize_configs
+
+      set_process_name
+
+      DaemonKit.logger.info( "DaemonKit (#{DaemonKit::VERSION}) booted, now running #{DaemonKit.configuration.daemon_name}" )
     end
 
     def set_load_path
@@ -96,9 +103,7 @@ module DaemonKit
     end
 
     def load_patches
-      if !!configuration.force_kill_wait
-        require 'daemon_kit/patches/force_kill_wait'
-      end
+
     end
 
     def load_environment
@@ -136,6 +141,8 @@ module DaemonKit
 
       DaemonKit.logger = logger
 
+      DaemonKit.logger.info "DaemonKit (#{DaemonKit::VERSION}) booting in #{DAEMON_ENV} mode"
+
       configuration.trap("USR1") {
         DaemonKit.logger.level = DaemonKit.logger.debug? ? Logger::INFO : Logger::DEBUG
         DaemonKit.logger.info "Log level changed to #{DaemonKit.logger.debug? ? 'DEBUG' : 'INFO' }"
@@ -144,8 +151,6 @@ module DaemonKit
         DaemonKit.logger.level = Logger::DEBUG
         DaemonKit.logger.info "Log level changed to DEBUG"
       }
-
-      DaemonKit.logger.info "DaemonKit up and running in #{DAEMON_ENV} mode"
     end
 
     def initialize_signal_traps
@@ -159,6 +164,10 @@ module DaemonKit
         require core_lib
       end
     end
+
+    def set_process_name
+      $0 = configuration.daemon_name
+    end
   end
 
   # Holds our various configuration values
@@ -175,21 +184,15 @@ module DaemonKit
     # Path to the log file, defaults to 'log/<environment>.log'
     attr_accessor :log_path
 
-    # :system,
-    attr_accessor :dir_mode
-
-    # Path to the log file, defaults to 'log/<environment>.log'
-    attr_accessor :dir
-
     # Provide a custom logger to use
     attr_accessor :logger
 
+    # Path to the pid file, defaults to 'log/<daemon_name>.pid'
+    attr_accessor :pid_file
+
     # The application name
     attr_accessor :daemon_name
 
-    # Allow multiple copies to run?
-    attr_accessor :multiple
-
     # Use the force kill patch? Give the number of seconds
     attr_accessor :force_kill_wait
 
@@ -200,6 +203,8 @@ module DaemonKit
     attr_accessor :safety_net
 
     def initialize
+      parse_arguments!
+
       set_root_path!
       set_daemon_defaults!
 
@@ -207,7 +212,6 @@ module DaemonKit
       self.log_level  = default_log_level
       self.log_path   = default_log_path
 
-      self.multiple = false
       self.force_kill_wait = false
 
       self.safety_net = DaemonKit::Safety.instance
@@ -240,6 +244,10 @@ module DaemonKit
       @signal_traps[signal].unshift( proc || block )
     end
 
+    def pid_file
+      @pid_file ||= "#{File.dirname(self.log_path)}/#{self.daemon_name}.pid"
+    end
+
     protected
 
     def run_traps( signal )
@@ -255,28 +263,57 @@ module DaemonKit
       Signal.trap( signal, Proc.new { self.run_traps( signal ) } )
     end
 
+    def parse_arguments!
+      return unless own_args?
+
+      configs = Arguments.configuration( ARGV ).first
+      @unused_arguments = {}
+
+      configs.each do |c|
+        k,v = c.split('=')
+
+        if v.nil?
+          error( "#{k} has no value" )
+          next
+        end
+
+        begin
+          if self.respond_to?( k )
+            self.send( "#{k}=", v ) # pid_file = /var/run/foo.pid
+          else
+            @unused_arguments[ k ] = v
+          end
+        rescue => e
+          error( "Couldn't set `#{k}' to `#{v}': #{e.message}" )
+        end
+      end
+    end
+
+    # DANGEROUS: Change the value of DAEMON_ENV
+    def environment=( env )
+      ::DAEMON_ENV.replace( env )
+    end
+
     def set_root_path!
       raise "DAEMON_ROOT is not set" unless defined?(::DAEMON_ROOT)
-      raise "DAEMON_ROOT is not a directory" unless defined?(::DAEMON_ROOT)
+      raise "DAEMON_ROOT is not a directory" unless File.directory?(::DAEMON_ROOT)
 
-      @root_path =
+      @root_path = ::DAEMON_ROOT.to_absolute_path
         # Pathname is incompatible with Windows, but Windows doesn't have
         # real symlinks so File.expand_path is safe.
-        if RUBY_PLATFORM =~ /(:?mswin|mingw)/
-          File.expand_path(::DAEMON_ROOT)
+        #if RUBY_PLATFORM =~ /(:?mswin|mingw)/
+        #  File.expand_path(::DAEMON_ROOT)
 
         # Otherwise use Pathname#realpath which respects symlinks.
-        else
-          Pathname.new(::DAEMON_ROOT).realpath.to_s
-        end
+        #else
+        #  File.expand_path( Pathname.new(::DAEMON_ROOT).realpath.to_s )
+        #end
 
       Object.const_set(:RELATIVE_DAEMON_ROOT, ::DAEMON_ROOT.dup) unless defined?(::RELATIVE_DAEMON_ROOT)
       ::DAEMON_ROOT.replace @root_path
     end
 
     def set_daemon_defaults!
-      self.dir_mode = :normal
-      self.dir      = File.join( DAEMON_ROOT, 'log' )
     end
 
     def default_load_paths
@@ -290,6 +327,23 @@ module DaemonKit
     def default_log_level
       environment == 'production' ? Logger::INFO : Logger::DEBUG
     end
+
+    def error( msg )
+      msg = "[E] Configuration: #{msg}"
+
+      if DaemonKit.logger
+        DaemonKit.logger.error( msg )
+      else
+        STDERR.puts msg
+      end
+    end
+
+    # If we are executed with any of these commands, don't allow
+    # arguments to be parsed cause they will interfere with the
+    # script encapsulating DaemonKit, like capistrano
+    def own_args?
+      ![ 'cap' ].include?( File.basename( $0 ) )
+    end
   end
 
 

data/lib/daemon_kit/pid_file.rb

@@ -0,0 +1,61 @@
+module DaemonKit
+
+  # Simple pidfile handling for daemon processes
+  class PidFile
+
+    def initialize( path )
+      @path = path.to_absolute_path
+    end
+
+    def exists?
+      File.exists?( @path )
+    end
+
+    # Returns true if the process is running
+    def running?
+      return false unless self.exists?
+
+      # 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, self.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
+
+    # Return the pid contained in the pidfile, or nil
+    def pid
+      return nil unless self.exists?
+
+      File.open( @path ) { |f|
+        return f.gets.to_i
+      }
+    end
+
+    def ensure_stopped!
+      if self.running?
+        puts "Process already running with id #{self.pid}"
+        exit 1
+      end
+    end
+
+    def cleanup
+      File.delete( @path ) rescue Errno::ENOENT
+    end
+    alias zap cleanup
+
+    def write!
+      File.open( @path, 'w' ) { |f|
+        f.puts Process.pid
+      }
+    end
+  end
+end