win32-service 1.0.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e27f59203c2e9c16dea5335981498b12a350f3b627e9991145fc51cccc7e1d8f
-  data.tar.gz: d692ad6fbbc89954be51465f0a5af4906554e1dcc72d4c30748e71156a07ad8c
+  metadata.gz: 075b8e2ab771fc4ebc29a9aceb821964ab09a269818d29c817cc5a6e2f7a7963
+  data.tar.gz: '08b022f0e37b205362e78f62e1f3b1d50282c2d3b36e46d87a57051109cf30d0'
 SHA512:
-  metadata.gz: 973eb074ad890a30ec58ff8befacd7a3c0b160dfe7f36c49d5a5ed6f70634cbf38909747e19609ccb085056c8070065029a0fed33440a8eeb0c339c036c1c0ae
-  data.tar.gz: 79e03a845dbad972be71566e1208bdb56bab7a6ba9673301030b819bd1bc3a40b78ab45142bef2161da2e1ea9075f205d9f92d94e0442bac1efba60b2d625234
+  metadata.gz: 525aa1428c908b058d6bed619aa520da199de71297883d0532c749e79c4e9332be34a8e63fb17a943cdac67505d1fe753e653d357b00927600f792b1991a75ef
+  data.tar.gz: 3a806a552ddb136a761fdc008ce9475f2ee4cae9127d7e5c0299ddc0d1dcdfa49195482432e068afe301e6441f05016ece41084eaebfc9be8d3f31728befe101

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

@@ -400,8 +400,8 @@ module Win32
           Service.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
@@ -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(
@@ -947,8 +947,8 @@ module Win32
           status[:dwServiceFlags]
         )
       ensure
-        CloseServiceHandle(handle_scs) if handle_scs && handle_scs > 0
-        CloseServiceHandle(handle_scm)
+        close_service_handle(handle_scs)
+        close_service_handle(handle_scm)
       end
 
       status_struct
@@ -1087,18 +1087,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 +1150,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 +1191,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 +1333,7 @@ module Win32
 
         unless bool
           error = FFI.errno
-          CloseServiceHandle(handle_scs)
+          close_service_handle(handle_scs)
           raise SystemCallError.new('OpenProcessToken', error)
         end
 
@@ -1235,7 +1344,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 +1368,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 +1412,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 +1668,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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32-service
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-15 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -39,6 +39,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  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: rspec-expectations
+  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: rspec-mocks
+  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: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -91,25 +133,8 @@ description: |2
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- CHANGELOG.md
-- README.md
-- MANIFEST
-- doc/service.txt
-- doc/daemon.txt
+extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- Gemfile
-- MANIFEST
-- README.md
-- Rakefile
-- VERSION
-- appveyor.yml
-- doc/daemon.txt
-- doc/service.txt
-- examples/demo_daemon.rb
-- examples/demo_daemon_ctl.rb
-- examples/demo_services.rb
 - lib/win32-daemon.rb
 - lib/win32-service.rb
 - lib/win32/daemon.rb
@@ -118,16 +143,9 @@ files:
 - lib/win32/windows/functions.rb
 - lib/win32/windows/structs.rb
 - lib/win32/windows/version.rb
-- test/test_win32_daemon.rb
-- test/test_win32_service.rb
-- test/test_win32_service_configure.rb
-- test/test_win32_service_create.rb
-- test/test_win32_service_info.rb
-- test/test_win32_service_status.rb
-- win32-service.gemspec
-homepage: http://github.com/chef/win32-service
+homepage: https://github.com/chef/win32-service
 licenses:
-- Artistic 2.0
+- Artistic-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -137,22 +155,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An interface for MS Windows services
-test_files:
-- test/test_win32_service.rb
-- test/test_win32_daemon.rb
-- test/test_win32_service_info.rb
-- test/test_win32_service_configure.rb
-- test/test_win32_service_status.rb
-- test/test_win32_service_create.rb
+test_files: []