win32-service 1.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e27f59203c2e9c16dea5335981498b12a350f3b627e9991145fc51cccc7e1d8f
-  data.tar.gz: d692ad6fbbc89954be51465f0a5af4906554e1dcc72d4c30748e71156a07ad8c
+  metadata.gz: ef70f0e8d16323dd531f4a6558b910121fa02ed62a432e5e82a70bfa19736805
+  data.tar.gz: f1128b7daa3ec6d64cb374c554c291b222f37dd10079865f5be6ae930287c0bc
 SHA512:
-  metadata.gz: 973eb074ad890a30ec58ff8befacd7a3c0b160dfe7f36c49d5a5ed6f70634cbf38909747e19609ccb085056c8070065029a0fed33440a8eeb0c339c036c1c0ae
-  data.tar.gz: 79e03a845dbad972be71566e1208bdb56bab7a6ba9673301030b819bd1bc3a40b78ab45142bef2161da2e1ea9075f205d9f92d94e0442bac1efba60b2d625234
+  metadata.gz: a9bb4ac05263a141d2a4fc1030e16b9d6df66af501917f3403fa082412055bd6c1118404e06b35531845bcbaa55ecd3f89e8677ec57c422b40c7cfa61d3a8e3d
+  data.tar.gz: be2e0f6108dd0093e582659ef201d78266cbcaa428e08eac3624146695bdc46337edbb3b5823179f3f5c541b881bb0e3d95c64fe1ef92ef636f1521a72053ef7

data/lib/win32/daemon.rb

@@ -1,6 +1,7 @@
 require_relative 'windows/constants'
 require_relative 'windows/structs'
 require_relative 'windows/functions'
+require_relative 'windows/version'
 
 # The Win32 module serves as a namespace only.
 module Win32
@@ -15,7 +16,7 @@ module Win32
     extend Windows::ServiceFunctions
 
     # The version of this library
-    VERSION = '0.8.10'.freeze
+    VERSION = Win32::Service::VERSION
 
     private
 

data/lib/win32/service.rb

@@ -397,11 +397,11 @@ module Win32
         if opts['failure_reset_period'] || opts['failure_reboot_message'] ||
            opts['failure_command'] || opts['failure_actions']
         then
-          Service.configure_failure_actions(handle_scs, opts)
+          self.class.configure_failure_actions(handle_scs, opts)
         end
       ensure
-        CloseServiceHandle(handle_scs) if handle_scs && handle_scs > 0
-        CloseServiceHandle(handle_scm) if handle_scm && handle_scm > 0
+        self.class.close_service_handle(handle_scs)
+        self.class.close_service_handle(handle_scm)
       end
 
       self
@@ -580,8 +580,8 @@ module Win32
           configure_failure_actions(handle_scs, opts)
         end
       ensure
-        CloseServiceHandle(handle_scs) if handle_scs && handle_scs > 0
-        CloseServiceHandle(handle_scm) if handle_scm && handle_scm > 0
+        close_service_handle(handle_scs)
+        close_service_handle(handle_scm)
       end
 
       self
@@ -605,8 +605,8 @@ module Win32
         handle_scs = OpenService(handle_scm, service, SERVICE_QUERY_STATUS)
         bool = true if handle_scs > 0
       ensure
-        CloseServiceHandle(handle_scm) if handle_scm && handle_scm > 0
-        CloseServiceHandle(handle_scs) if handle_scs && handle_scs > 0
+        close_service_handle(handle_scm)
+        close_service_handle(handle_scs)
       end
 
       bool
@@ -644,7 +644,7 @@ module Win32
 
         FFI.raise_windows_error('OpenSCManager') unless bool
       ensure
-        CloseServiceHandle(handle_scm)
+        close_service_handle(handle_scm)
       end
 
       display_name.read_string
@@ -681,7 +681,7 @@ module Win32
 
         FFI.raise_windows_error('GetServiceKeyName') unless bool
       ensure
-        CloseServiceHandle(handle_scm)
+        close_service_handle(handle_scm)
       end
 
       service_name.read_string
@@ -735,8 +735,8 @@ module Win32
         end
 
       ensure
-        CloseServiceHandle(handle_scs) if handle_scs && handle_scs > 0
-        CloseServiceHandle(handle_scm)
+        close_service_handle(handle_scs)
+        close_service_handle(handle_scm)
       end
 
       self
@@ -824,8 +824,8 @@ module Win32
           FFI.raise_windows_error('DeleteService')
         end
       ensure
-        CloseServiceHandle(handle_scs) if handle_scs && handle_scs > 0
-        CloseServiceHandle(handle_scm)
+        close_service_handle(handle_scs)
+        close_service_handle(handle_scm)
       end
 
       self
@@ -873,8 +873,8 @@ module Win32
 
         FFI.raise_windows_error('QueryServiceConfig') unless bool
       ensure
-        CloseServiceHandle(handle_scs) if handle_scs && handle_scs > 0
-        CloseServiceHandle(handle_scm)
+        close_service_handle(handle_scs)
+        close_service_handle(handle_scm)
       end
 
       ConfigStruct.new(
@@ -898,59 +898,41 @@ module Win32
     # Service.status('W32Time') => <struct Struct::ServiceStatus ...>
     #
     def self.status(service, host=nil)
-      handle_scm = OpenSCManager(host, nil, SC_MANAGER_ENUMERATE_SERVICE)
-
-      FFI.raise_windows_error('OpenSCManager') if handle_scm == 0
-
-      begin
-        handle_scs = OpenService(
-          handle_scm,
-          service,
-          SERVICE_QUERY_STATUS
-        )
-
-        FFI.raise_windows_error('OpenService') if handle_scs == 0
-
-        # SERVICE_STATUS_PROCESS struct
-        status = SERVICE_STATUS_PROCESS.new
-        bytes  = FFI::MemoryPointer.new(:ulong)
-
-        bool = QueryServiceStatusEx(
-          handle_scs,
-          SC_STATUS_PROCESS_INFO,
-          status,
-          status.size,
-          bytes
-        )
+      status = SERVICE_STATUS_PROCESS.new
+      bytes  = FFI::MemoryPointer.new(:ulong)
+
+      open_sc_manager(host) do |scm_handle|
+        open_service(scm_handle, service, SERVICE_QUERY_STATUS) do |service_handle|
+          bool = QueryServiceStatusEx(
+            service_handle,
+            SC_STATUS_PROCESS_INFO,
+            status,
+            status.size,
+            bytes
+          )
 
-        FFI.raise_windows_error('QueryServiceStatusEx') unless bool
-
-        service_type  = get_service_type(status[:dwServiceType])
-        current_state = get_current_state(status[:dwCurrentState])
-        controls      = get_controls_accepted(status[:dwControlsAccepted])
-        interactive   = status[:dwServiceType] & SERVICE_INTERACTIVE_PROCESS > 0
-
-        # Note that the pid and service flags will always return 0 if you're
-        # on Windows NT 4 or using a version of Ruby compiled with VC++ 6
-        # or earlier.
-        #
-        status_struct = StatusStruct.new(
-          service_type,
-          current_state,
-          controls,
-          status[:dwWin32ExitCode],
-          status[:dwServiceSpecificExitCode],
-          status[:dwCheckPoint],
-          status[:dwWaitHint],
-          interactive,
-          status[:dwProcessId],
-          status[:dwServiceFlags]
-        )
-      ensure
-        CloseServiceHandle(handle_scs) if handle_scs && handle_scs > 0
-        CloseServiceHandle(handle_scm)
+          FFI.raise_windows_error('QueryServiceStatusEx') unless bool
+        end
       end
 
+      service_type  = get_service_type(status[:dwServiceType])
+      current_state = get_current_state(status[:dwCurrentState])
+      controls      = get_controls_accepted(status[:dwControlsAccepted])
+      interactive   = status[:dwServiceType] & SERVICE_INTERACTIVE_PROCESS > 0
+
+      status_struct = StatusStruct.new(
+        service_type,
+        current_state,
+        controls,
+        status[:dwWin32ExitCode],
+        status[:dwServiceSpecificExitCode],
+        status[:dwCheckPoint],
+        status[:dwWaitHint],
+        interactive,
+        status[:dwProcessId],
+        status[:dwServiceFlags]
+      )
+
       status_struct
     end
 
@@ -1087,18 +1069,7 @@ module Win32
                 description = ''
               end
 
-              begin
-                delayed_start_buf = get_config2_info(handle_scs, SERVICE_CONFIG_DELAYED_AUTO_START_INFO)
-                if delayed_start_buf.is_a?(FFI::MemoryPointer)
-                  delayed_start_info = SERVICE_DELAYED_AUTO_START_INFO.new(delayed_start_buf)
-                  delayed_start = delayed_start_info[:fDelayedAutostart]
-                else
-                  delayed_start = false
-                end
-              rescue
-                warn "WARNING: Unable to get delayed auto start information for the #{service_name} service"
-                delayed_start = nil
-              end
+              delayed_start = delayed_start(service_name)
             else
               warn "WARNING: The registry entry for the #{service_name} service could not be found"
 
@@ -1161,7 +1132,7 @@ module Win32
               actions      = nil
             end
           ensure
-            CloseServiceHandle(handle_scs) if handle_scs > 0
+            close_service_handle(handle_scs)
           end
 
           struct = ServiceStruct.new(
@@ -1202,12 +1173,132 @@ module Win32
           service_buf += ENUM_SERVICE_STATUS_PROCESS.size
         }
       ensure
-        CloseServiceHandle(handle_scm)
+        close_service_handle(handle_scm)
       end
 
       block_given? ? nil : services_array
     end
 
+    #
+    # Attempts to get the delayed_start attribute for the named +service+ on +host+,
+    # or the local machine if no host is provided.
+    #
+    # @example Get 'SomeSvc' delayed start on the local machine
+    #    Service.delayed_start('SomeSvc') # => 1
+    # @example Get 'SomeSvc' delayed start on host foo
+    #    Service.delayed_start('SomeSvc', 'foo') # => 1
+    #
+    # @param service [String] Service name (e.g. `"Dhcp"`)
+    # @param host [String] Host of service (e.g. `"mymachine"`)
+    # @return [Integer, false, nil] Returns `1` when delayed start is enabled
+    #   and `0` when it is not enabled. Returns nil or false when there is
+    #   a problem of some kind.
+    #
+    def self.delayed_start(service, host = nil)
+      handle_scm = OpenSCManager(host, nil, SC_MANAGER_ENUMERATE_SERVICE)
+
+      FFI.raise_windows_error('OpenSCManager') if handle_scm == 0
+
+      handle_scs = OpenService(
+        handle_scm,
+        service,
+        SERVICE_QUERY_CONFIG
+      )
+
+      FFI.raise_windows_error('OpenService') if handle_scs == 0
+
+      delayed_start_buf = get_config2_info(handle_scs, SERVICE_CONFIG_DELAYED_AUTO_START_INFO)
+      if delayed_start_buf.is_a?(FFI::MemoryPointer)
+        delayed_start_info = SERVICE_DELAYED_AUTO_START_INFO.new(delayed_start_buf)
+        delayed_start = delayed_start_info[:fDelayedAutostart]
+      else
+        delayed_start = false
+      end
+    rescue SystemCallError
+      delayed_start = nil
+    ensure
+      close_service_handle(handle_scs)
+      close_service_handle(handle_scm)
+    end
+
+    def self.close_service_handle(handle)
+      case handle
+      when NilClass
+        false
+      when Integer
+        handle > 0 ? CloseServiceHandle(handle) : false
+      else
+        raise ArgumentError, "You must pass a valid handle to ::close_service_handle"
+      end
+    end
+
+    #
+    # Opens an existing service.
+    #
+    # @example
+    #   open_sc_manager do |scm_handle|
+    #     open_service(scm_handle, 'Dhcp', SERVICE_ALL_ACCESS) do |service_handle|
+    #       p service_handle
+    #     end
+    #   end
+    #
+    # @param scm_handle [Integer] pointer to Service Control Manager
+    # @param service_name [String] Name of the service
+    # @param desired_access [Integer] The access to the service. For a list of
+    #   access rights, see `Windows::ServiceConstants`.
+    #
+    # @see Windows::ServiceConstants
+    #
+    def self.open_service(scm_handle, service_name, desired_access)
+       service_handle = OpenService(
+        scm_handle,
+        service_name,
+        desired_access
+      )
+      FFI.raise_windows_error('OpenService') if service_handle == 0
+
+      if block_given?
+        yield service_handle
+      else
+        service_handle
+      end
+    ensure
+      close_service_handle(service_handle) if block_given?
+    end
+
+    #
+    # Establishes a connection to the service control manager on the specified
+    # host and opens the SERVICES_ACTIVE_DATABASE service control manager
+    # database.
+    #
+    # @example
+    #   open_sc_manager(nil, SC_MANAGER_ENUMERATE_SERVICE) do |scm_handle|
+    #     p scm_handle
+    #   end
+    #
+    # @param host [String] Name of host you want to connect to. If `nil` it
+    #   will connect to the local host.
+    # @param desired_access [Integer] The access to the service control
+    #   manager.
+    # @return [Integer] If the function succeeds, the return value is a handle
+    #   to the specified service control manager database. If the function
+    #   fails, the return value is 0.
+    #
+    # @see Windows::ServiceConstants
+    #
+    def self.open_sc_manager(host = nil, desired_access = SC_MANAGER_CONNECT)
+      scm_handle = OpenSCManager(host, nil, desired_access)
+      FFI.raise_windows_error('OpenSCManager') if scm_handle == 0
+
+      if block_given?
+        yield scm_handle
+      else
+        scm_handle
+      end
+    ensure
+      close_service_handle(scm_handle) if block_given?
+    end
+
     private
 
     # Configures failure actions for a given service.
@@ -1224,7 +1315,7 @@ module Win32
 
         unless bool
           error = FFI.errno
-          CloseServiceHandle(handle_scs)
+          close_service_handle(handle_scs)
           raise SystemCallError.new('OpenProcessToken', error)
         end
 
@@ -1235,7 +1326,7 @@ module Win32
 
         unless LookupPrivilegeValue('', 'SeShutdownPrivilege', luid)
           error = FFI.errno
-          CloseServiceHandle(handle_scs)
+          close_service_handle(handle_scs)
           raise SystemCallError.new('LookupPrivilegeValue', error)
         end
 
@@ -1259,7 +1350,7 @@ module Win32
 
         unless bool
           error = FFI.errno
-          CloseServiceHandle(handle_scs)
+          close_service_handle(handle_scs)
           raise SystemCallError.new('AdjustTokenPrivileges', error)
         end
       end
@@ -1303,7 +1394,7 @@ module Win32
 
       unless bool
         error = FFI.errno
-        CloseServiceHandle(handle_scs)
+        close_service_handle(handle_scs)
         raise SystemCallError.new('ChangeServiceConfig2', error)
       end
     end
@@ -1559,8 +1650,8 @@ module Win32
           FFI.raise_windows_error('ControlService')
         end
       ensure
-        CloseServiceHandle(handle_scs) if handle_scs && handle_scs > 0
-        CloseServiceHandle(handle_scm) if handle_scm && handle_scm > 0
+        close_service_handle(handle_scs)
+        close_service_handle(handle_scm)
       end
 
       status

data/lib/win32/windows/functions.rb

@@ -1,4 +1,4 @@
-require 'ffi'
+require 'ffi' unless defined?(FFI)
 
 module Windows
   module ServiceFunctions

data/lib/win32/windows/structs.rb

@@ -1,4 +1,4 @@
-require 'ffi'
+require 'ffi' unless defined?(FFI)
 
 module Windows
   module ServiceStructs
@@ -68,20 +68,6 @@ module Windows
       end
     end
 
-    class SERVICE_STATUS_PROCESS < FFI::Struct
-      layout(
-        :dwServiceType, :dword,
-        :dwCurrentState, :dword,
-        :dwControlsAccepted, :dword,
-        :dwWin32ExitCode, :dword,
-        :dwServiceSpecificExitCode, :dword,
-        :dwCheckPoint, :dword,
-        :dwWaitHint, :dword,
-        :dwProcessId, :dword,
-        :dwServiceFlags, :dword
-      )
-    end
-
     class ENUM_SERVICE_STATUS_PROCESS < FFI::Struct
       layout(
         :lpServiceName, :pointer,

data/lib/win32/windows/version.rb

@@ -1,6 +1,6 @@
 module Win32
   class Service
-    VERSION = "1.0.1"
+    VERSION = "2.2.0"
     MAJOR, MINOR, TINY = VERSION.split(".")
   end
 end