win32-service 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9da3b7cac48ec6cfe0304595e3b6c6cdf8a7480
-  data.tar.gz: e71218d14b39f03d49582806ae139306c4570883
+  metadata.gz: 9eb593fe954a9ad9baa295314a6deba834e416f5
+  data.tar.gz: b8ddb7267b81ea05bcf0c211ab684d07571a2d5b
 SHA512:
-  metadata.gz: 7952a1dcd227fbcf118cbfdc1c3d9efcd681b82a4f3f10e331506e4cecae2456c3d181fe2c853d056c7c197f83b3d72d3506d0313234c6297127e5c0910fdda8
-  data.tar.gz: 293fc5528459592f6cb781b48959db7184a88da758197271fa3f2bc2ed74c717b79e558d87381820b66c2d5cf2e1cc418b88e1efb915421f0d3674e40446a3de
+  metadata.gz: 59a97083e2ff8900d2f80244a6313452e8479f8d577abee74b6af9bc1a397979d28d043537d6b22c49a90d8d287b1423e53f8349cc2d4ae76022df3c58285bd0
+  data.tar.gz: cd0285acd389d078041dd27252c0da1880044b5100f8f848d323b05bbacf9c86d541f2d0c3dd696f70f075745f1949dcafebdf677ca330c8dfdb7c701ae36962

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.8.6 - 21-Aug-2014
+* Some internal changes that make stopping a service more robust. Thanks go
+  to Ethan J. Brown for the patches.
+* Renamed the constants module to avoid name clashes. Thanks go to Michael
+  Smith for the spot.
+
 == 0.8.5 - 2-Jul-2014
 * The service type for Service.new no longer defaults to being an interactive
   process. This could cause process credential issues and wasn't very

data/lib/win32/daemon.rb

@@ -10,7 +10,7 @@ module Win32
 
   # The Daemon class
   class Daemon
-    include Windows::Constants
+    include Windows::ServiceConstants
     include Windows::Structs
     include Windows::Functions
 
@@ -18,7 +18,7 @@ module Win32
     extend Windows::Functions
 
     # The version of this library
-    VERSION = '0.8.4'
+    VERSION = '0.8.6'
 
     private
 
@@ -103,80 +103,91 @@ module Win32
       end
     end
 
+    ERROR_CALL_NOT_IMPLEMENTED = 0x78
+
     # Handles control signals from the service control manager.
     Service_Ctrl_ex = Proc.new do |dwCtrlCode,dwEventType,lpEventData,lpContext|
       @@waiting_control_code = dwCtrlCode;
+      return_value = NO_ERROR
+
+      begin
+        dwState = SERVICE_RUNNING
+
+        case dwCtrlCode
+          when SERVICE_CONTROL_STOP
+            dwState = SERVICE_STOP_PENDING
+          when SERVICE_CONTROL_SHUTDOWN
+            dwState = SERVICE_STOP_PENDING
+          when SERVICE_CONTROL_PAUSE
+            dwState = SERVICE_PAUSED
+          when SERVICE_CONTROL_CONTINUE
+            dwState = SERVICE_RUNNING
+          #else
+            # TODO: Handle other control codes? Retain the current state?
+        end
 
-      dwState = SERVICE_RUNNING
-
-      case dwCtrlCode
-        when SERVICE_CONTROL_STOP
-          dwState = SERVICE_STOP_PENDING
-        when SERVICE_CONTROL_SHUTDOWN
-          dwState = SERVICE_STOP_PENDING
-        when SERVICE_CONTROL_PAUSE
-          dwState = SERVICE_PAUSED
-        when SERVICE_CONTROL_CONTINUE
-          dwState = SERVICE_RUNNING
-        #else
-          # TODO: Handle other control codes? Retain the current state?
-      end
-
-      # Set the status of the service except on interrogation.
-      unless dwCtrlCode == SERVICE_CONTROL_INTERROGATE
-        SetTheServiceStatus.call(dwState, NO_ERROR, 0, 0)
-      end
+        # Set the status of the service except on interrogation.
+        unless dwCtrlCode == SERVICE_CONTROL_INTERROGATE
+          SetTheServiceStatus.call(dwState, NO_ERROR, 0, 0)
+        end
 
-      # Tell service_main thread to stop.
-      if dwCtrlCode == SERVICE_CONTROL_STOP || dwCtrlCode == SERVICE_CONTROL_SHUTDOWN
-        if !SetEvent(@@hStopEvent)
-          SetTheServiceStatus.call(SERVICE_STOPPED, FFI.errno, 0, 0)
+        # Tell service_main thread to stop.
+        if dwCtrlCode == SERVICE_CONTROL_STOP || dwCtrlCode == SERVICE_CONTROL_SHUTDOWN
+          if SetEvent(@@hStopEvent) == 0
+            SetTheServiceStatus.call(SERVICE_STOPPED, FFI.errno, 0, 0)
+          end
         end
+      rescue
+        return_value = ERROR_CALL_NOT_IMPLEMENTED
       end
+
+      return_value
     end
 
     # Called by the service control manager after the call to StartServiceCtrlDispatcher.
     Service_Main = FFI::Function.new(:void, [:ulong, :pointer], :blocking => false) do |dwArgc,lpszArgv|
-      # Obtain the name of the service.
-      if lpszArgv.address!=0
-        argv = lpszArgv.get_array_of_string(0,dwArgc)
-        lpszServiceName = argv[0]
-      else
-        lpszServiceName = ''
-      end
+      begin
+        # Obtain the name of the service.
+        if lpszArgv.address!=0
+          argv = lpszArgv.get_array_of_string(0,dwArgc)
+          lpszServiceName = argv[0]
+        else
+          lpszServiceName = ''
+        end
 
-      # Args passed to Service.start
-      if(dwArgc > 1)
-        @@Argv = argv[1..-1]
-      else
-        @@Argv = nil
-      end
+        # Args passed to Service.start
+        if(dwArgc > 1)
+          @@Argv = argv[1..-1]
+        else
+          @@Argv = nil
+        end
 
-      # Register the service ctrl handler.
-      @@ssh = RegisterServiceCtrlHandlerEx(
-        lpszServiceName,
-        Service_Ctrl_ex,
-        nil
-      )
+        # Register the service ctrl handler.
+        @@ssh = RegisterServiceCtrlHandlerEx(
+          lpszServiceName,
+          Service_Ctrl_ex,
+          nil
+        )
 
-      # No service to stop, no service handle to notify, nothing to do but exit.
-      return if @@ssh == 0
+        # No service to stop, no service handle to notify, nothing to do but exit.
+        return if @@ssh == 0
 
-      # The service has started.
-      SetTheServiceStatus.call(SERVICE_RUNNING, NO_ERROR, 0, 0)
+        # The service has started.
+        SetTheServiceStatus.call(SERVICE_RUNNING, NO_ERROR, 0, 0)
 
-      SetEvent(@@hStartEvent)
+        SetEvent(@@hStartEvent)
 
-      # Main loop for the service.
-      while(WaitForSingleObject(@@hStopEvent, 1000) != WAIT_OBJECT_0) do
-      end
+        # Main loop for the service.
+        while(WaitForSingleObject(@@hStopEvent, 1000) != WAIT_OBJECT_0) do
+        end
 
-      # Main loop for the service.
-      while(WaitForSingleObject(@@hStopCompletedEvent, 1000) != WAIT_OBJECT_0) do
+        # Main loop for the service.
+        while(WaitForSingleObject(@@hStopCompletedEvent, 1000) != WAIT_OBJECT_0) do
+        end
+      ensure
+        # Stop the service.
+        SetTheServiceStatus.call(SERVICE_STOPPED, NO_ERROR, 0, 0)
       end
-
-      # Stop the service.
-      SetTheServiceStatus.call(SERVICE_STOPPED, NO_ERROR, 0, 0)
     end
 
     ThreadProc = FFI::Function.new(:ulong,[:pointer]) do |lpParameter|
@@ -184,7 +195,7 @@ module Win32
 
       s = SERVICE_TABLE_ENTRY.new(ste[0])
       s[:lpServiceName] = FFI::MemoryPointer.from_string('')
-      s[:lpServiceProc] = Service_Main
+      s[:lpServiceProc] = lpParameter
 
       s = SERVICE_TABLE_ENTRY.new(ste[1])
       s[:lpServiceName] = nil
@@ -249,13 +260,13 @@ module Win32
         raise SystemCallError.new('CreateEvent', FFI.errno)
       end
 
-      hThread = CreateThread(nil, 0, ThreadProc, nil, 0, nil)
+      hThread = CreateThread(nil, 0, ThreadProc, Service_Main, 0, nil)
 
       if hThread == 0
         raise SystemCallError.new('CreateThread', FFI.errno)
       end
 
-      events = FFI::MemoryPointer.new(:pointer, FFI::Pointer.size*2)
+      events = FFI::MemoryPointer.new(:pointer, 2)
       events.put_pointer(0, FFI::Pointer.new(hThread))
       events.put_pointer(FFI::Pointer.size, FFI::Pointer.new(@@hStartEvent))
 
@@ -272,33 +283,36 @@ module Win32
       end
 
       thr = Thread.new do
-        while(WaitForSingleObject(@@hStopEvent, 10) == WAIT_TIMEOUT)
-          # Check to see if anything interesting has been signaled
-          case @@waiting_control_code
-            when SERVICE_CONTROL_PAUSE
-              service_pause() if respond_to?('service_pause')
-            when SERVICE_CONTROL_CONTINUE
-              service_resume() if respond_to?('service_resume')
-            when SERVICE_CONTROL_INTERROGATE
-              service_interrogate() if respond_to?('service_interrogate')
-            when SERVICE_CONTROL_SHUTDOWN
-              service_shutdown() if respond_to?('service_shutdown')
-            when SERVICE_CONTROL_PARAMCHANGE
-              service_paramchange() if respond_to?('service_paramchange')
-            when SERVICE_CONTROL_NETBINDADD
-              service_netbindadd() if respond_to?('service_netbindadd')
-            when SERVICE_CONTROL_NETBINDREMOVE
-              service_netbindremove() if respond_to?('service_netbindremove')
-            when SERVICE_CONTROL_NETBINDENABLE
-              service_netbindenable() if respond_to?('service_netbindenable')
-            when SERVICE_CONTROL_NETBINDDISABLE
-              service_netbinddisable() if respond_to?('service_netbinddisable')
+        begin
+          while(WaitForSingleObject(@@hStopEvent, 10) == WAIT_TIMEOUT)
+            # Check to see if anything interesting has been signaled
+            case @@waiting_control_code
+              when SERVICE_CONTROL_PAUSE
+                service_pause() if respond_to?('service_pause')
+              when SERVICE_CONTROL_CONTINUE
+                service_resume() if respond_to?('service_resume')
+              when SERVICE_CONTROL_INTERROGATE
+                service_interrogate() if respond_to?('service_interrogate')
+              when SERVICE_CONTROL_SHUTDOWN
+                service_shutdown() if respond_to?('service_shutdown')
+              when SERVICE_CONTROL_PARAMCHANGE
+                service_paramchange() if respond_to?('service_paramchange')
+              when SERVICE_CONTROL_NETBINDADD
+                service_netbindadd() if respond_to?('service_netbindadd')
+              when SERVICE_CONTROL_NETBINDREMOVE
+                service_netbindremove() if respond_to?('service_netbindremove')
+              when SERVICE_CONTROL_NETBINDENABLE
+                service_netbindenable() if respond_to?('service_netbindenable')
+              when SERVICE_CONTROL_NETBINDDISABLE
+                service_netbinddisable() if respond_to?('service_netbinddisable')
+            end
+            @@waiting_control_code = IDLE_CONTROL_CODE
           end
-          @@waiting_control_code = IDLE_CONTROL_CODE
-        end
 
-        service_stop() if respond_to?('service_stop')
-        SetEvent(@@hStopCompletedEvent)
+          service_stop() if respond_to?('service_stop')
+        ensure
+          SetEvent(@@hStopCompletedEvent)
+        end
       end
 
       if respond_to?('service_main')

data/lib/win32/service.rb

@@ -9,7 +9,7 @@ module Win32
   # The Service class encapsulates services controller actions, such as
   # creating, starting, configuring or deleting services.
   class Service
-    include Windows::Constants
+    include Windows::ServiceConstants
     include Windows::Structs
     include Windows::Functions
 
@@ -17,7 +17,7 @@ module Win32
     extend Windows::Functions
 
     # The version of the win32-service library
-    VERSION = '0.8.5'
+    VERSION = '0.8.6'
 
     # SCM security and access rights
 
@@ -1075,12 +1075,18 @@ module Win32
 
               deps = config_struct[:lpDependencies].read_array_of_null_separated_strings
 
-              buf = get_config2_info(handle_scs, SERVICE_CONFIG_DESCRIPTION)
-
-              if buf.is_a?(Fixnum) || buf.read_pointer.null?
+              begin
+                buf = get_config2_info(handle_scs, SERVICE_CONFIG_DESCRIPTION)
+
+                if buf.is_a?(Fixnum) || buf.read_pointer.null?
+                  description = ''
+                else
+                  description = buf.read_pointer.read_string
+                end
+              rescue
+                # While being annoying, not being able to get a description is not exceptional
+                warn "WARNING: Failed to retreive description for the #{service_name} service."
                 description = ''
-              else
-                description = buf.read_pointer.read_string
               end
 
               delayed_start_buf = get_config2_info(handle_scs, SERVICE_CONFIG_DELAYED_AUTO_START_INFO)
@@ -1367,7 +1373,7 @@ module Win32
       #
       if !bool && err_num == ERROR_INSUFFICIENT_BUFFER
         config2_buf = FFI::MemoryPointer.new(:char, bytes_needed.read_ulong)
-      elsif [ERROR_FILE_NOT_FOUND, ERROR_RESOURCE_TYPE_NOT_FOUND].include?(err_num)
+      elsif [ERROR_FILE_NOT_FOUND, ERROR_RESOURCE_TYPE_NOT_FOUND, ERROR_RESOURCE_NAME_NOT_FOUND].include?(err_num)
         return err_num
       else
         CloseServiceHandle(handle)

data/lib/win32/windows/constants.rb

@@ -1,5 +1,5 @@
 module Windows
-  module Constants
+  module ServiceConstants
     SC_MANAGER_ALL_ACCESS         = 0xF003F
     SC_MANAGER_CREATE_SERVICE     = 0x0002
     SC_MANAGER_CONNECT            = 0x0001
@@ -137,6 +137,7 @@ module Windows
     ERROR_MORE_DATA = 234
     ERROR_FILE_NOT_FOUND = 2
     ERROR_RESOURCE_TYPE_NOT_FOUND = 1813
+    ERROR_RESOURCE_NAME_NOT_FOUND = 1814
     WAIT_FAILED = 0xFFFFFFFF
   end
 end

data/win32-service.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'win32-service'
-  spec.version    = '0.8.5'
+  spec.version    = '0.8.6'
   spec.authors    = ['Daniel J. Berger', 'Park Heesob']
   spec.license    = 'Artistic 2.0'
   spec.email      = 'djberg96@gmail.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32-service
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -9,48 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
@@ -102,17 +102,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: An interface for MS Windows services