win32-service 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef70f0e8d16323dd531f4a6558b910121fa02ed62a432e5e82a70bfa19736805
-  data.tar.gz: f1128b7daa3ec6d64cb374c554c291b222f37dd10079865f5be6ae930287c0bc
+  metadata.gz: d6e082fe0332a702fd8a8abe6be757173ac44a97f5aca6b544e63aea98435e41
+  data.tar.gz: 22628c39784ab449296e8775298bbb9502b1fd944097dfa7c8fac25b423f1f69
 SHA512:
-  metadata.gz: a9bb4ac05263a141d2a4fc1030e16b9d6df66af501917f3403fa082412055bd6c1118404e06b35531845bcbaa55ecd3f89e8677ec57c422b40c7cfa61d3a8e3d
-  data.tar.gz: be2e0f6108dd0093e582659ef201d78266cbcaa428e08eac3624146695bdc46337edbb3b5823179f3f5c541b881bb0e3d95c64fe1ef92ef636f1521a72053ef7
+  metadata.gz: 3c20950b21f865da21aef986bed1d8f9eb72cca83f6e78f91bf4abc963bce43ae715b73a3ed5e72cc2649138209bd2120cb8e38870487620d728e264864db8fc
+  data.tar.gz: 4327e6a58cc533509506ad72783f2150f6d84ff60df1661abc8b3a5b7193d0627ed806e09c2db219ebc390202a9fa2e91902ee27eac0ff6ffac39966bb9e9a6d

data/lib/win32/daemon.rb

@@ -1,7 +1,7 @@
-require_relative 'windows/constants'
-require_relative 'windows/structs'
-require_relative 'windows/functions'
-require_relative 'windows/version'
+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
@@ -18,8 +18,6 @@ module Win32
     # The version of this library
     VERSION = Win32::Service::VERSION
 
-    private
-
     # Service is not running
     STOPPED = SERVICE_STOPPED
 
@@ -73,16 +71,16 @@ module Win32
     IDLE = 0
 
     # Wraps SetServiceStatus.
-    SetTheServiceStatus = Proc.new do |dwCurrentState, dwWin32ExitCode,dwCheckPoint,  dwWaitHint|
-      ss = SERVICE_STATUS.new  # Current status of the service.
+    SetTheServiceStatus = Proc.new do |dwCurrentState, dwWin32ExitCode, dwCheckPoint, dwWaitHint|
+      ss = SERVICE_STATUS.new # Current status of the service.
 
       # Disable control requests until the service is started.
       if dwCurrentState == SERVICE_START_PENDING
         ss[:dwControlsAccepted] = 0
       else
         ss[:dwControlsAccepted] =
-        SERVICE_ACCEPT_STOP|SERVICE_ACCEPT_SHUTDOWN|
-        SERVICE_ACCEPT_PAUSE_CONTINUE|SERVICE_ACCEPT_PARAMCHANGE
+          SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_SHUTDOWN |
+          SERVICE_ACCEPT_PAUSE_CONTINUE | SERVICE_ACCEPT_PARAMCHANGE
       end
 
       # Initialize ss structure.
@@ -96,7 +94,7 @@ module Win32
       @@dwServiceState = dwCurrentState
 
       # Send status of the service to the Service Controller.
-      if !SetServiceStatus(@@ssh, ss)
+      unless SetServiceStatus(@@ssh, ss)
         SetEvent(@@hStopEvent)
       end
     end
@@ -104,8 +102,8 @@ module Win32
     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;
+    Service_Ctrl_ex = Proc.new do |dwCtrlCode, dwEventType, lpEventData, lpContext|
+      @@waiting_control_code = dwCtrlCode
       return_value = NO_ERROR
 
       begin
@@ -120,8 +118,8 @@ module Win32
             dwState = SERVICE_PAUSED
           when SERVICE_CONTROL_CONTINUE
             dwState = SERVICE_RUNNING
-          #else
-            # TODO: Handle other control codes? Retain the current state?
+          # else
+          # TODO: Handle other control codes? Retain the current state?
         end
 
         # Set the status of the service except on interrogation.
@@ -143,56 +141,56 @@ module Win32
     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|
-      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
+    Service_Main = FFI::Function.new(:void, %i{ulong pointer}, blocking: false) do |dwArgc, lpszArgv|
 
-        # Args passed to Service.start
-        if(dwArgc > 1)
-          @@Argv = argv[1..-1]
-        else
-          @@Argv = nil
-        end
+      # Obtain the name of the service.
+      if lpszArgv.address != 0
+        argv = lpszArgv.get_array_of_string(0, dwArgc)
+        lpszServiceName = argv[0]
+      else
+        lpszServiceName = ""
+      end
 
-        # Register the service ctrl handler.
-        @@ssh = RegisterServiceCtrlHandlerEx(
-          lpszServiceName,
-          Service_Ctrl_ex,
-          nil
-        )
+      # Args passed to Service.start
+      if dwArgc > 1
+        @@Argv = argv[1..-1]
+      else
+        @@Argv = nil
+      end
 
-        # No service to stop, no service handle to notify, nothing to do but exit.
-        return if @@ssh == 0
+      # Register the service ctrl handler.
+      @@ssh = RegisterServiceCtrlHandlerEx(
+        lpszServiceName,
+        Service_Ctrl_ex,
+        nil
+      )
 
-        # The service has started.
-        SetTheServiceStatus.call(SERVICE_RUNNING, NO_ERROR, 0, 0)
+      # No service to stop, no service handle to notify, nothing to do but exit.
+      return if @@ssh == 0 # rubocop:disable Lint/NonLocalExitFromIterator
 
-        SetEvent(@@hStartEvent)
+      # The service has started.
+      SetTheServiceStatus.call(SERVICE_RUNNING, NO_ERROR, 0, 0)
 
-        # Main loop for the service.
-        while(WaitForSingleObject(@@hStopEvent, 1000) != WAIT_OBJECT_0) do
-        end
+      SetEvent(@@hStartEvent)
 
-        # 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)
+      # Main loop for the service.
+      while WaitForSingleObject(@@hStopEvent, 1000) != WAIT_OBJECT_0
       end
+
+      # Main loop for the service.
+      while WaitForSingleObject(@@hStopCompletedEvent, 1000) != WAIT_OBJECT_0
+      end
+    ensure
+      # Stop the service.
+      SetTheServiceStatus.call(SERVICE_STOPPED, NO_ERROR, 0, 0)
+
     end
 
-    ThreadProc = FFI::Function.new(:ulong,[:pointer]) do |lpParameter|
+    ThreadProc = FFI::Function.new(:ulong, [:pointer]) do |lpParameter|
       ste = FFI::MemoryPointer.new(SERVICE_TABLE_ENTRY, 2)
 
       s = SERVICE_TABLE_ENTRY.new(ste[0])
-      s[:lpServiceName] = FFI::MemoryPointer.from_string('')
+      s[:lpServiceName] = FFI::MemoryPointer.from_string("")
       s[:lpServiceProc] = lpParameter
 
       s = SERVICE_TABLE_ENTRY.new(ste[1])
@@ -200,19 +198,17 @@ module Win32
       s[:lpServiceProc] = nil
 
       # No service to step, no service handle, no ruby exceptions, just terminate the thread..
-      if !StartServiceCtrlDispatcher(ste)
+      unless StartServiceCtrlDispatcher(ste)
         return 1
       end
 
       return 0
     end
 
-    public
-
     # This is a shortcut for Daemon.new + Daemon#mainloop.
     #
     def self.mainloop
-      self.new.mainloop
+      new.mainloop
     end
 
     # This is the method that actually puts your code into a loop and allows it
@@ -225,9 +221,9 @@ module Win32
 
       # Redirect STDIN, STDOUT and STDERR to the NUL device if they're still
       # associated with a tty. This helps newbs avoid Errno::EBADF errors.
-      STDIN.reopen('NUL') if STDIN.isatty
-      STDOUT.reopen('NUL') if STDOUT.isatty
-      STDERR.reopen('NUL') if STDERR.isatty
+      STDIN.reopen("NUL") if STDIN.isatty
+      STDOUT.reopen("NUL") if STDOUT.isatty
+      STDERR.reopen("NUL") if STDERR.isatty
 
       # Calling init here so that init failures never even tries to start the
       # service. Of course that means that init methods must be very quick
@@ -235,44 +231,44 @@ module Win32
       # init's running.
       #
       # TODO: Fix?
-      service_init() if respond_to?('service_init')
+      service_init if respond_to?("service_init")
 
       # Create the event to signal the service to start.
       @@hStartEvent = CreateEvent(nil, 1, 0, nil)
 
       if @@hStartEvent == 0
-        raise SystemCallError.new('CreateEvent', FFI.errno)
+        raise SystemCallError.new("CreateEvent", FFI.errno)
       end
 
       # Create the event to signal the service to stop.
       @@hStopEvent = CreateEvent(nil, 1, 0, nil)
 
       if @@hStopEvent == 0
-        raise SystemCallError.new('CreateEvent', FFI.errno)
+        raise SystemCallError.new("CreateEvent", FFI.errno)
       end
 
       # Create the event to signal the service that stop has completed
       @@hStopCompletedEvent = CreateEvent(nil, 1, 0, nil)
 
       if @@hStopCompletedEvent == 0
-        raise SystemCallError.new('CreateEvent', FFI.errno)
+        raise SystemCallError.new("CreateEvent", FFI.errno)
       end
 
       hThread = CreateThread(nil, 0, ThreadProc, Service_Main, 0, nil)
 
       if hThread == 0
-        raise SystemCallError.new('CreateThread', FFI.errno)
+        raise SystemCallError.new("CreateThread", FFI.errno)
       end
 
       events = FFI::MemoryPointer.new(:pointer, 2)
       events.put_pointer(0, FFI::Pointer.new(hThread))
       events.put_pointer(FFI::Pointer.size, FFI::Pointer.new(@@hStartEvent))
 
-      while ((index = WaitForMultipleObjects(2, events, 0, 1000)) == WAIT_TIMEOUT) do
+      while (index = WaitForMultipleObjects(2, events, 0, 1000)) == WAIT_TIMEOUT
       end
 
       if index == WAIT_FAILED
-        raise SystemCallError.new('WaitForMultipleObjects', FFI.errno)
+        raise SystemCallError.new("WaitForMultipleObjects", FFI.errno)
       end
 
       # The thread exited, so the show is off.
@@ -281,39 +277,47 @@ module Win32
       end
 
       thr = Thread.new do
-        begin
-          while(WaitForSingleObject(@@hStopEvent, 1000) == 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')
+
+        while WaitForSingleObject(@@hStopEvent, 1000) == 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
+
+          # handle user defined control codes
+          if @@waiting_control_code.between?(128, 255)
+            if respond_to?("service_user_defined_control")
+              service_user_defined_control(@@waiting_control_code)
             end
-            @@waiting_control_code = IDLE_CONTROL_CODE
           end
 
-          service_stop() if respond_to?('service_stop')
-        ensure
-          SetEvent(@@hStopCompletedEvent)
+          @@waiting_control_code = IDLE_CONTROL_CODE
         end
+
+        service_stop if respond_to?("service_stop")
+      ensure
+        SetEvent(@@hStopCompletedEvent)
+
       end
 
-      if respond_to?('service_main')
+      if respond_to?("service_main")
         service_main(*@@Argv)
       end