rexec 1.2.1 → 1.2.3

data/lib/rexec/daemon.rb

@@ -1,27 +1,27 @@
-# Copyright (c) 2007, 2009 Samuel Williams. Released under the GNU GPLv3.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
+# Copyright (c) 2007, 2009, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
 # 
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 # 
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 
 require 'rexec/daemon/base'
 
 module RExec
-  module Daemon
-    
-    # Would this kind of API be useful?
-    #def run_daemon(options = {}, &block)
-    #  
-    #end
-    
-  end
+	module Daemon
+		
+	end
 end

data/lib/rexec/daemon/base.rb

@@ -1,151 +1,166 @@
-# Copyright (c) 2007, 2009 Samuel Williams. Released under the GNU GPLv3.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
+# Copyright (c) 2007, 2009, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
 # 
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 # 
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 
 require 'fileutils'
 require 'rexec/daemon/controller'
 require 'rexec/reverse_io'
 
 module RExec
-  module Daemon
-    # This class is the base daemon class. If you are writing a daemon, you should inherit from this class.
-    class Base
-      @@var_directory = nil
-      @@log_directory = nil
-      @@pid_directory = nil
-      
-      # Return the name of the daemon
-      def self.daemon_name
-        return name.gsub(/[^a-zA-Z0-9]+/, '-')
-      end
-
-      # Base directory for daemon log files / run files
-      def self.var_directory
-        @@var_directory || File.join("", "var")
-      end
-      
-      # The directory the daemon will run in (Dir.chdir)
-      def self.working_directory
-        var_directory
-      end
-
-      # Return the directory to store log files in
-      def self.log_directory
-        @@log_directory || File.join(var_directory, "log", daemon_name)
-      end
-
-      # Standard log file for errors
-      def self.err_fn
-        File.join(log_directory, "stderr.log")
-      end
-
-      # Standard log file for normal output
-      def self.log_fn
-        File.join(log_directory, "stdout.log")
-      end
-
-      # Standard location of pid file
-      def self.pid_directory
-        @@pid_directory || File.join(var_directory, "run", daemon_name)
-      end
-
-      # Standard pid file
-      def self.pid_fn
-        File.join(pid_directory, "#{daemon_name}.pid")
-      end
-
-      # Mark the error log
-      def self.mark_err_log
-        fp = File.open(err_fn, "a")
-        fp.puts "=== Error Log Opened @ #{Time.now.to_s} ==="
-        fp.close
-      end
-
-      # Prints some information relating to daemon startup problems
-      def self.tail_err_log(outp)
-        lines = []
-        
-        File.open(err_fn, "r") do |fp|
-          fp.seek_end
-
-          fp.reverse_each_line do |line|
-            lines << line
-            break if line.match("=== Error Log") || line.match("=== Daemon Exception Backtrace")
-          end
-        end
-        
-        lines.reverse_each do |line|
-          outp.puts line
-        end
-      end
-
-      # Check the last few lines of the log file to find out if
-      # the daemon crashed.
-      def self.crashed?
-        File.open(err_fn, "r") do |fp|
-          fp.seek_end
-          
-          count = 2
-          fp.reverse_each_line do |line|
-            return true if line.match("=== Daemon Crashed")
-            
-            count -= 1
-            
-            break if count == 0
-          end
-        end
-        
-        return false
-      end
-
-      # Corresponds to controller method of the same name
-      def self.daemonize
-        Controller.daemonize(self)
-      end
-
-      # Corresponds to controller method of the same name
-      def self.start
-        Controller.start(self)
-      end
-
-      # Corresponds to controller method of the same name
-      def self.stop
-        Controller.stop(self)
-      end
-
-      # Corresponds to controller method of the same name
-      def self.status
-        Controller.status(self)
-      end
-
-      # The main function to setup any environment required by the daemon
-      def self.prefork
-        @@var_directory = File.expand_path(@@var_directory) if @@var_directory
-        @@log_directory = File.expand_path(@@log_directory) if @@log_directory
-        @@pid_directory = File.expand_path(@@pid_directory) if @@pid_directory
-        
-        FileUtils.mkdir_p(log_directory)
-        FileUtils.mkdir_p(pid_directory)
-      end
-      
-      # The main function to start the daemon
-      def self.run
-      end
-
-      # The main function to stop the daemon
-      def self.shutdown
-      end
-    end
-  end
+	module Daemon
+		# This class is the base daemon class. If you are writing a daemon, you should inherit from this class.
+		#
+		# The basic structure of a daemon is as follows:
+		# 	
+		# 	class Server < RExec::Daemon::Base
+		# 		def self.run
+		# 			# Long running process, e.g. web server, game server, etc.
+		# 		end
+		# 	end
+		# 	
+		# 	Server.daemonize
+		class Base
+			@@var_directory = nil
+			@@log_directory = nil
+			@@pid_directory = nil
+
+			# Return the name of the daemon
+			def self.daemon_name
+				return name.gsub(/[^a-zA-Z0-9]+/, '-')
+			end
+
+			# Base directory for daemon log files / run files
+			def self.var_directory
+				@@var_directory || File.join("", "var")
+			end
+
+			# The directory the daemon will run in (Dir.chdir)
+			def self.working_directory
+				var_directory
+			end
+
+			# Return the directory to store log files in
+			def self.log_directory
+				@@log_directory || File.join(var_directory, "log", daemon_name)
+			end
+
+			# Standard log file for errors
+			def self.err_fn
+				File.join(log_directory, "stderr.log")
+			end
+
+			# Standard log file for normal output
+			def self.log_fn
+				File.join(log_directory, "stdout.log")
+			end
+
+			# Standard location of pid file
+			def self.pid_directory
+				@@pid_directory || File.join(var_directory, "run", daemon_name)
+			end
+
+			# Standard pid file
+			def self.pid_fn
+				File.join(pid_directory, "#{daemon_name}.pid")
+			end
+
+			# Mark the error log
+			def self.mark_err_log
+				fp = File.open(err_fn, "a")
+				fp.puts "=== Error Log Opened @ #{Time.now.to_s} ==="
+				fp.close
+			end
+
+			# Prints some information relating to daemon startup problems
+			def self.tail_err_log(outp)
+				lines = []
+
+				File.open(err_fn, "r") do |fp|
+					fp.seek_end
+
+					fp.reverse_each_line do |line|
+						lines << line
+						break if line.match("=== Error Log") || line.match("=== Daemon Exception Backtrace")
+					end
+				end
+
+				lines.reverse_each do |line|
+					outp.puts line
+				end
+			end
+
+			# Check the last few lines of the log file to find out if
+			# the daemon crashed.
+			def self.crashed?
+				File.open(err_fn, "r") do |fp|
+					fp.seek_end
+
+					count = 2
+					fp.reverse_each_line do |line|
+						return true if line.match("=== Daemon Crashed")
+
+						count -= 1
+
+						break if count == 0
+					end
+				end
+
+				return false
+			end
+
+			# Corresponds to controller method of the same name
+			def self.daemonize
+				Controller.daemonize(self)
+			end
+
+			# Corresponds to controller method of the same name
+			def self.start
+				Controller.start(self)
+			end
+
+			# Corresponds to controller method of the same name
+			def self.stop
+				Controller.stop(self)
+			end
+
+			# Corresponds to controller method of the same name
+			def self.status
+				Controller.status(self)
+			end
+
+			# The main function to setup any environment required by the daemon
+			def self.prefork
+				@@var_directory = File.expand_path(@@var_directory) if @@var_directory
+				@@log_directory = File.expand_path(@@log_directory) if @@log_directory
+				@@pid_directory = File.expand_path(@@pid_directory) if @@pid_directory
+
+				FileUtils.mkdir_p(log_directory)
+				FileUtils.mkdir_p(pid_directory)
+			end
+
+			# The main function to start the daemon
+			def self.run
+			end
+
+			# The main function to stop the daemon
+			def self.shutdown
+			end
+		end
+	end
 end

data/lib/rexec/daemon/controller.rb

@@ -1,17 +1,22 @@
-# Copyright (c) 2007, 2009 Samuel Williams. Released under the GNU GPLv3.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
+# Copyright (c) 2007, 2009, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
 # 
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 # 
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 
 require 'rexec/daemon/pidfile'
 require 'rexec/task'
@@ -24,7 +29,7 @@ module RExec
 		# This module contains functionality related to starting and stopping the daemon, and code for processing command line input.
 		module Controller
 			# This function is called from the daemon executable. It processes ARGV and checks whether the user is asking for
-			# <tt>start</tt>, <tt>stop</tt>, <tt>restart</tt> or <tt>status</tt>.
+			# +start+, +stop+, +restart+ or +status+.
 			def self.daemonize(daemon)
 				#puts "Running in #{WorkingDirectory}, logs in #{LogDirectory}"
 				case !ARGV.empty? && ARGV[0]

data/lib/rexec/daemon/pidfile.rb

@@ -1,64 +1,69 @@
-# Copyright (c) 2007, 2009 Samuel Williams. Released under the GNU GPLv3.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
+# Copyright (c) 2007, 2009, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
 # 
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 # 
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 
 module RExec
-  module Daemon
-    # This module controls the storage and retrieval of process id files.
-    module PidFile
-      # Saves the pid for the given daemon
-      def self.store(daemon, pid)
-        File.open(daemon.pid_fn, 'w') {|f| f << pid}
-      end
+	module Daemon
+		# This module controls the storage and retrieval of process id files.
+		module PidFile
+			# Saves the pid for the given daemon
+			def self.store(daemon, pid)
+				File.open(daemon.pid_fn, 'w') {|f| f << pid}
+			end
+
+			# Retrieves the pid for the given daemon
+			def self.recall(daemon)
+				IO.read(daemon.pid_fn).to_i rescue nil
+			end
 
-      # Retrieves the pid for the given daemon
-      def self.recall(daemon)
-        IO.read(daemon.pid_fn).to_i rescue nil
-      end
+			# Removes the pid saved for a particular daemon
+			def self.clear(daemon)
+				if File.exist? daemon.pid_fn
+					FileUtils.rm(daemon.pid_fn)
+				end
+			end
 
-      # Removes the pid saved for a particular daemon
-      def self.clear(daemon)
-        if File.exist? daemon.pid_fn
-          FileUtils.rm(daemon.pid_fn)
-        end
-      end
+			# Checks whether the daemon is running by checking the saved pid and checking the corresponding process
+			def self.running(daemon)
+				pid = recall(daemon)
 
-      # Checks whether the daemon is running by checking the saved pid and checking the corresponding process
-      def self.running(daemon)
-        pid = recall(daemon)
+				return false if pid == nil
 
-        return false if pid == nil
+				gpid = Process.getpgid(pid) rescue nil
 
-        gpid = Process.getpgid(pid) rescue nil
+				return gpid != nil ? true : false
+			end
 
-        return gpid != nil ? true : false
-      end
+			# Remove the pid file if the daemon is not running
+			def self.cleanup(daemon)
+				clear(daemon) unless running(daemon)
+			end
 
-      # Remove the pid file if the daemon is not running
-      def self.cleanup(daemon)
-        clear(daemon) unless running(daemon)
-      end
-      
-      # This function returns the status of the daemon. This can be one of <tt>:running</tt>, <tt>:unknown</tt> (pid file exists but no 
-      # corresponding process can be found) or <tt>:stopped</tt>.
-      def self.status(daemon)
-        if File.exist? daemon.pid_fn
-          return PidFile.running(daemon) ? :running : :unknown
-        else
-          return :stopped
-        end
-      end
-    end
-  end
+			# This function returns the status of the daemon. This can be one of +:running+, +:unknown+ (pid file exists but no 
+			# corresponding process can be found) or +:stopped+.
+			def self.status(daemon)
+				if File.exist? daemon.pid_fn
+					return PidFile.running(daemon) ? :running : :unknown
+				else
+					return :stopped
+				end
+			end
+		end
+	end
 end