win32-service 0.6.0 → 0.6.1

data/CHANGES

@@ -1,3 +1,10 @@
+== 0.6.1 - 1-Jan-2008
+* The Service.services method now handles the scenario where a particular
+  service may still exist, but its underlying registry entry has been deleted.
+  In this case, most ServiceInfo struct members are set to nil and a warning
+  is issued.
+* RDoc updates.
+
 == 0.6.0 - 25-Nov-2007
 * The Service control class is now pure Ruby. The Daemon class is still C,
   however. That may change in the future. This means the windows-pr

data/doc/daemon.txt

@@ -140,7 +140,7 @@ Daemon::IDLE
    service responsiveness issues.
     
 = Copyright
-   (C) 2003-2007 Daniel J. Berger, All Rights Reserved
+   (C) 2003-2008 Daniel J. Berger, All Rights Reserved
 
 = License
    Ruby's

data/doc/service.txt

@@ -16,8 +16,6 @@
    require "win32/service"
    include Win32
     
-   s = Service.new("some_machine")
-    
    # Create a new service
    Service.create('some_service', nil, 
       :service_type       => Service::WIN32_OWN_PROCESS,
@@ -352,7 +350,7 @@ Service::ERROR_CRITICAL
    Use RegisterServiceCtrlHandlerEx().
     
 = Copyright
-   (C) 2003-2007, Daniel J. Berger, All Rights Reserved
+   (C) 2003-2008, Daniel J. Berger, All Rights Reserved
     
 = License
    Ruby's

data/ext/win32/daemon.c

@@ -5,7 +5,7 @@
 #include <malloc.h>
 #include <tchar.h>
 
-#define WIN32_SERVICE_VERSION "0.6.0"
+#define WIN32_SERVICE_VERSION "0.6.1"
 
 static VALUE cDaemonError;
 
@@ -482,15 +482,15 @@ static VALUE daemon_mainloop(VALUE self)
  * of the service status constants, e.g. RUNNING, PAUSED, etc.
  * 
  * This method is typically used within your service_main method to setup the
- * loop.  For example:
+ * loop. For example:
  * 
- * class MyDaemon < Daemon
- *    def service_main
- * 		while state == RUNNING || state == PAUSED || state == IDLE
- * 			# Your main loop here
- * 		end
- * 	end
- * end
+ *    class MyDaemon < Daemon
+ *       def service_main
+ *          while state == RUNNING || state == PAUSED || state == IDLE
+ *             # Your main loop here
+ *          end
+ *       end
+ *    end
  * 
  * See the Daemon#running? method for an abstraction of the above code.
  */
@@ -503,15 +503,15 @@ static VALUE daemon_state(VALUE self){
  * status is either RUNNING, PAUSED or IDLE.
  * 
  * This is typically used within your service_main method to setup the main
- * loop.  For example:
+ * loop. For example:
  * 
- * class MyDaemon < Daemon
- *    def service_main
- *       while running?
- *          # Your main loop here
+ *    class MyDaemon < Daemon
+ *       def service_main
+ *          while running?
+ *             # Your main loop here
+ *          end
  *       end
  *    end
- * end
  */
 static VALUE daemon_is_running(VALUE self){
    VALUE v_bool = Qfalse;
@@ -527,7 +527,7 @@ static VALUE daemon_is_running(VALUE self){
 }
 
 /* 
- * This is a shortcut for Daemon#new + Daemon#mainloop.
+ * This is a shortcut for Daemon.new + Daemon#mainloop.
  */
 static VALUE daemon_c_mainloop(VALUE klass){
    VALUE v_args[1];
@@ -537,11 +537,15 @@ static VALUE daemon_c_mainloop(VALUE klass){
 
 void Init_daemon()
 {
-   VALUE mWin32, cDaemon;
+   /* The Win32 module serves as a namespace only. */
+   VALUE mWin32 = rb_define_module("Win32");
+
+   /* The Daemon class encapsulates a Windows service through the use
+    * of callback methods and a main loop.
+    */
+   VALUE cDaemon = rb_define_class_under(mWin32, "Daemon", rb_cObject);
 
-   // Modules and classes
-   mWin32       = rb_define_module("Win32");
-   cDaemon      = rb_define_class_under(mWin32, "Daemon", rb_cObject);
+   /* Error typically raised if something goes wrong with your daemon. */
    cDaemonError = rb_define_class_under(cDaemon, "Error", rb_eStandardError);
 
    rb_define_alloc_func(cDaemon, daemon_allocate);
@@ -556,7 +560,7 @@ void Init_daemon()
 
    // Constants
    
-   /* 0.6.0: The version of this library */
+   /* 0.6.1: The version of this library */
    rb_define_const(cDaemon, "VERSION", rb_str_new2(WIN32_SERVICE_VERSION));
    
    /* Service has received a signal to resume but is not yet running */

data/lib/win32/service.rb

@@ -6,8 +6,15 @@ require 'windows/security'
 require 'windows/msvcrt/string'
 require 'windows/msvcrt/buffer'
 
+# The Win32 module serves as a namespace only.
 module Win32
+
+   # The Service class encapsulates services controller actions, such as
+   # creating, starting, configuring or deleting services.
    class Service
+
+      # This is the error typically raised if one of the Service methods
+      # should fail for any reason.
       class Error < StandardError; end
       
       include Windows::Error
@@ -25,7 +32,7 @@ module Win32
       extend Windows::MSVCRT::String
       extend Windows::MSVCRT::Buffer
       
-      VERSION = '0.6.0'
+      VERSION = '0.6.1'
       
       # SCM security and access rights
       
@@ -197,6 +204,7 @@ module Win32
       # Run a command
       ACTION_RUN_COMMAND = SC_ACTION_RUN_COMMAND
       
+      # :stopdoc: #
       StatusStruct = Struct.new('ServiceStatus', :service_type,
          :current_state, :controls_accepted, :win32_exit_code,
          :service_specific_exit_code, :check_point, :wait_hint, :interactive,
@@ -216,6 +224,8 @@ module Win32
          :description, :interactive, :pid, :service_flags, :reset_period,
          :reboot_message, :command, :num_actions, :actions
       )
+
+      # :startdoc: #
       
       # Creates a new service with +service_name+ on +host+, or the local host
       # if no host is specified. The +options+ parameter is a hash that can
@@ -242,7 +252,7 @@ module Win32
       # Example:
       #
       #    # Configure everything
-      #    Service.create('some_service', nil, 
+      #    Service.new('some_service', nil, 
       #       :service_type       => Service::WIN32_OWN_PROCESS,
       #       :description        => 'A custom service I wrote just for fun',
       #       :start_type         => Service::AUTO_START,
@@ -1084,59 +1094,81 @@ module Win32
 
             config_buf = get_config_info(handle_scs)
 
-            binary_path = 0.chr * 260
-            strcpy(binary_path, config_buf[12,4].unpack('L').first)
-            binary_path = binary_path.unpack('Z*')[0]
+            if config_buf != ERROR_FILE_NOT_FOUND
+               binary_path = 0.chr * 260
+               strcpy(binary_path, config_buf[12,4].unpack('L').first)
+               binary_path = binary_path.unpack('Z*')[0]
 
-            load_order = 0.chr * 260
-            strcpy(load_order, config_buf[16,4].unpack('L').first)
-            load_order = load_order.unpack('Z*')[0]
+               load_order = 0.chr * 260
+               strcpy(load_order, config_buf[16,4].unpack('L').first)
+               load_order = load_order.unpack('Z*')[0]
             
-            start_name = 0.chr * 260
-            strcpy(start_name, config_buf[28,4].unpack('L').first)
-            start_name = start_name.unpack('Z*')[0]
+               start_name = 0.chr * 260
+               strcpy(start_name, config_buf[28,4].unpack('L').first)
+               start_name = start_name.unpack('Z*')[0]
             
-            start_type    = get_start_type(config_buf[4,4].unpack('L').first)
-            error_control = get_error_control(config_buf[8,4].unpack('L').first)
+               start_type = get_start_type(config_buf[4,4].unpack('L').first)
+               error_ctrl = get_error_control(config_buf[8,4].unpack('L').first)
 
-            tag_id = config_buf[20,4].unpack('L').first
+               tag_id = config_buf[20,4].unpack('L').first
 
-            dependencies = get_dependencies(config_buf[24,4].unpack('L').first)
+               deps = get_dependencies(config_buf[24,4].unpack('L').first)
 
-            description = 0.chr * 1024
-            buf = get_config2_info(handle_scs, SERVICE_CONFIG_DESCRIPTION) 
+               description = 0.chr * 1024
+               buf = get_config2_info(handle_scs, SERVICE_CONFIG_DESCRIPTION) 
 
-            strcpy(description, buf[0,4].unpack('L').first)
-            description = description.unpack('Z*')[0]
+               strcpy(description, buf[0,4].unpack('L').first)
+               description = description.unpack('Z*')[0]
+            else
+               msg = "WARNING: The registry entry for the #{service_name} "
+               msg += "service could not be found."
+               warn msg
+              
+               binary_path = nil
+               load_order  = nil
+               start_name  = nil
+               start_type  = nil
+               error_ctrl  = nil
+               tag_id      = nil
+               deps        = nil
+               description = nil
+            end
             
             buf2 = get_config2_info(handle_scs, SERVICE_CONFIG_FAILURE_ACTIONS)
             
-            reset_period = buf2[0,4].unpack('L').first
+            if buf2 != ERROR_FILE_NOT_FOUND
+               reset_period = buf2[0,4].unpack('L').first
             
-            reboot_msg = 0.chr * 260
-            strcpy(reboot_msg, buf2[4,4].unpack('L').first)
-            reboot_msg = reboot_msg.unpack('Z*')[0]
+               reboot_msg = 0.chr * 260
+               strcpy(reboot_msg, buf2[4,4].unpack('L').first)
+               reboot_msg = reboot_msg.unpack('Z*')[0]
             
-            command = 0.chr * 260
-            strcpy(command, buf2[8,4].unpack('L').first)
-            command = command.unpack('Z*')[0]
+               command = 0.chr * 260
+               strcpy(command, buf2[8,4].unpack('L').first)
+               command = command.unpack('Z*')[0]
             
-            num_actions = buf2[12,4].unpack('L').first
-            actions = nil
+               num_actions = buf2[12,4].unpack('L').first
+               actions = nil
             
-            if num_actions > 0
-               action_ptr = buf2[16,4].unpack('L').first
-               action_buf = [0,0].pack('LL') * num_actions
-               memcpy(action_buf, action_ptr, action_buf.size)
+               if num_actions > 0
+                  action_ptr = buf2[16,4].unpack('L').first
+                  action_buf = [0,0].pack('LL') * num_actions
+                  memcpy(action_buf, action_ptr, action_buf.size)
                
-               i = 0
-               actions = {}
-               num_actions.times{ |n|
-                  action_type, delay = action_buf[i, 8].unpack('LL')
-                  action_type = get_action_type(action_type)
-                  actions[n+1] = {:action_type => action_type, :delay => delay}
-                  i += 8
-               }
+                  i = 0
+                  actions = {}
+                  num_actions.times{ |n|
+                     action_type, delay = action_buf[i, 8].unpack('LL')
+                     action_type = get_action_type(action_type)
+                     actions[n+1] = {:action_type => action_type, :delay => delay}
+                     i += 8
+                  }
+               end
+            else
+               reset_period   = nil
+               reboot_message = nil
+               command        = nil
+               actions        = nil
             end
 
             CloseServiceHandle(handle_scs)
@@ -1153,11 +1185,11 @@ module Win32
                wait_hint,
                binary_path,
                start_type,
-               error_control,
+               error_ctrl,
                load_order,
                tag_id,
                start_name,
-               dependencies,
+               deps,
                description,
                interactive,
                pid,
@@ -1316,7 +1348,10 @@ module Win32
          end
       end
 
-      # Shortcut for QueryServiceConfig. Returns the buffer.
+      # Shortcut for QueryServiceConfig. Returns the buffer. In rare cases
+      # the underlying registry entry may have been deleted, but the service
+      # still exists. In that case, the ERROR_FILE_NOT_FOUND value is returned
+      # instead.
       #
       def self.get_config_info(handle)
          bytes_needed = [0].pack('L')
@@ -1328,6 +1363,8 @@ module Win32
 
          if !bool && err_num == ERROR_INSUFFICIENT_BUFFER
             config_buf = 0.chr * bytes_needed.unpack('L').first
+         elsif err_num == ERROR_FILE_NOT_FOUND
+            return err_num
          else
             error = get_last_error(err_num)
             CloseServiceHandle(handle)
@@ -1361,13 +1398,15 @@ module Win32
          # First attempt at QueryServiceConfig2 is to get size needed
          bool = QueryServiceConfig2(handle, info_level, 0, 0, bytes_needed)
 
-         error = GetLastError()
+         err_num = GetLastError()
 
-         if !bool && error == ERROR_INSUFFICIENT_BUFFER
+         if !bool && err_num == ERROR_INSUFFICIENT_BUFFER
             config2_buf = 0.chr * bytes_needed.unpack('L').first
+         elsif err_num == ERROR_FILE_NOT_FOUND
+            return err_num
          else
             CloseServiceHandle(handle)
-            raise Error, error
+            raise Error, get_last_error(err_num)
          end
          
          bytes_needed = [0].pack('L')
@@ -1382,8 +1421,9 @@ module Win32
          )
 
          unless bool
+            error = GetLastError()
             CloseServiceHandle(handle)
-            raise Error, get_last_error
+            raise Error, get_last_error(error)
          end
          
          config2_buf

data/test/tc_daemon.rb

@@ -17,7 +17,7 @@ class TC_Daemon < Test::Unit::TestCase
    end
    
    def test_version
-      assert_equal('0.6.0', Daemon::VERSION)
+      assert_equal('0.6.1', Daemon::VERSION)
    end
    
    def test_constructor

data/test/tc_service.rb

@@ -20,7 +20,7 @@ class TC_Win32_Service < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('0.6.0', Win32::Service::VERSION)
+      assert_equal('0.6.1', Win32::Service::VERSION)
    end
 
    def test_service_configure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win32-service
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2007-11-25 00:00:00 -07:00
+date: 2008-01-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,18 +35,18 @@ extra_rdoc_files:
 - doc/service.txt
 - doc/daemon.txt
 files: 
+- doc/daemon.txt
+- doc/service.txt
 - test/tc_daemon.rb
 - test/tc_service.rb
 - test/tc_service_create.rb
 - test/tc_service_info.rb
 - test/tc_service_status.rb
 - lib/win32/service.rb
+- ext/win32/daemon.c
 - CHANGES
 - README
 - MANIFEST
-- ext/win32/daemon.c
-- doc/service.txt
-- doc/daemon.txt
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/win32utils
 post_install_message: 
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: win32utils
-rubygems_version: 0.9.5
+rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
 summary: An library for controlling and creating MS Windows services