win32-service 1.0.1 → 2.2.0

data/Gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in win32-service.gemspec
-gemspec
-

data/MANIFEST

@@ -1,24 +0,0 @@
-* MANIFEST
-* CHANGES
-* README
-* Rakefile
-* win32-service.gemspec
-* certs/djberg96_pub.pem
-* 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/service.rb
-* lib/win32/daemon.rb
-* lib/win32/windows/constants.rb
-* lib/win32/windows/functions.rb
-* lib/win32/windows/structs.rb
-* test/test_win32_daemon.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
-* test/test_win32_service.rb

data/README.md

@@ -1,75 +0,0 @@
-# win32-service
-
-[![Gem Version](https://badge.fury.io/rb/win32-service.svg)](https://badge.fury.io/rb/win32-service)
-
-The win32-service library allows you to control or create MS Windows services.
-
-## Installation
-
-gem install win32-service
-
-## Usage
-
-```ruby
-require 'win32/service'
-
-# Iterate over the available services
-Win32::Service.services do |service|
-  p service
-end
-```
-
-## More Documentation
-
-Please see the documentation in the 'doc' directory, or the gem documentation that was installed when you installed this library as a gem.
-
-## Known Issues
-
-### Problem:
-
-Service.delete causes "Unable to delete: The specified service has been marked for deletion."
-
-### Troubleshooting:
-
-This can be caused by one of two things. Either you attempted to delete a running service without stopping it first, or you have the Services Administrative Tool (GUI) open. In the former case, the solution is to first stop the service if it's running. In the latter, close the Services GUI admin tool before deleting.
-
-### Problem:
-
-Service.start causes, "The service did not respond to the start or control request in a timely fashion."
-
-### Troubleshooting:
-
-The best way to debug your services is to wrap your entire Daemon subclass in a begin/end block and send error messages to a file. That should give a good clue as to the nature of the problem. The most probable culprits are:
-
-- You forgot to require 'win32/daemon' in your Daemon code.
-
-- You've tried to require a library that's not in your $LOAD_PATH. Make sure that your require statements are inside the begin/rescue block so that you can easily find those mistakes.
-
-- Your have a bad binary path name. Be sure to use an absolute path name for the binary path name, including the full path to the Ruby interpreter, e.g. 'c:\ruby\bin\ruby' instead of just 'ruby'.
-
-- You've got a syntax error in your code somewhere.
-
-## See Also
-
-ruby-wmi
-
-## Future Plans
-
-Add service_session_change hook
-
-## Copyright
-
-(C) 2003-2018, Daniel J. Berger, All Rights Reserved
-
-## License
-
-Artistic 2.0
-
-## Warranty
-
-This package is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.
-
-## Authors
-
-- Daniel J. Berger
-- Park Heesob

data/Rakefile

@@ -1,83 +0,0 @@
-require "rubygems"
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rbconfig'
-include RbConfig
-
-CLEAN.include(
-  '**/*.gem', # Gem files
-  '**/*.rbc'  # Rubinius
-)
-
-namespace :example do
-  desc "Run the services example program."
-  task :services do
-    sh "ruby -Ilib examples/demo_services.rb"
-  end
-end
-
-namespace 'test' do
-  desc 'Run all tests for the win32-service library'
-  Rake::TestTask.new('all') do |t|
-    t.verbose = true
-    t.warning = true
-  end
-
-  desc 'Run the tests for the Win32::Daemon class'
-  Rake::TestTask.new('daemon') do |t|
-    task :daemon
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_win32_daemon.rb']
-  end
-
-  namespace 'service' do
-    desc 'Run the tests for the Win32::Service class'
-    Rake::TestTask.new('all') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service*.rb']
-    end
-
-    Rake::TestTask.new('configure') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service_configure.rb']
-    end
-
-    Rake::TestTask.new('control') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service.rb']
-    end
-
-    Rake::TestTask.new('create') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service_create.rb']
-    end
-
-    Rake::TestTask.new('info') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service_info.rb']
-    end
-
-    Rake::TestTask.new('status') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service_status.rb']
-    end
-  end
-
-  task :all do
-    Rake.application[:clean].execute
-  end
-
-  task :daemon do
-    Rake.application[:clean].execute
-  end
-end
-
-task :default => 'test:all'

data/VERSION

@@ -1 +0,0 @@
-1.0.1

data/appveyor.yml

@@ -1,48 +0,0 @@
-version: '{build}'
-branches:
-  only:
-  - ffi
-skip_tags: true
-clone_depth: 10
-environment:
-  matrix:
-  - ruby_version: 193
-    ruby_dir: 1.9.1
-  - ruby_version: 200
-    ruby_dir: 2.0.0
-  - ruby_version: 200-x64
-    ruby_dir: 2.0.0
-  - ruby_version: 21
-    ruby_dir: 2.1.0
-  - ruby_version: 21-x64
-    ruby_dir: 2.1.0
-  - ruby_version: 22
-    ruby_dir: 2.2.0
-  - ruby_version: 22-x64
-    ruby_dir: 2.2.0
-install:
-- ps: >-
-    $env:path = "C:\Ruby" + $env:ruby_version + "\bin;" + $env:path
-
-    $tpath = "C:\Ruby" + $env:ruby_version + "\lib\ruby\" + $env:ruby_dir + "\test"
-
-    if ((test-path $tpath) -eq $True){ rm -recurse -force $tpath }
-
-    gem update --system > $null
-
-    if ((gem query -i ffi) -eq $False){ gem install ffi --no-document }
-
-    if ((gem query -i win32-security) -eq $False){ gem install win32-security --no-document }
-
-    if ((gem query -i test-unit -v ">= 3.0") -eq $False){ gem install test-unit --no-document }
-cache:
-- C:\Ruby193\lib\ruby\gems\1.9.1
-- C:\Ruby200\lib\ruby\gems\2.0.0
-- C:\Ruby200-x64\lib\ruby\gems\2.0.0
-- C:\Ruby21\lib\ruby\gems\2.1.0
-- C:\Ruby21-x64\lib\ruby\gems\2.1.0
-- C:\Ruby22\lib\ruby\gems\2.2.0
-- C:\Ruby22-x64\lib\ruby\gems\2.2.0
-build: off
-test_script:
-- cmd: rake

data/doc/daemon.txt

@@ -1,157 +0,0 @@
-= Description
-  The Daemon class is a wrapper class that allows you to run your code as a
-  Windows service.
-
-= Synopsis
-  class Daemon
-    def service_main
-      while running?
-        sleep 3
-        File.open("c:\\test.log", "a"){ |f| f.puts "service is running" }
-      end
-    end
-  end
-
-  Daemon.mainloop
-    
-= Singleton Methods
-Daemon.mainloop
-  This is the method that actually puts your code into a loop and allows it
-  to run as a service. The code that is actually run while in the mainloop
-  is what you defined in the Daemon#service_main method.
-
-= Instance Methods 
-Daemon#running?
-  Returns whether or not the daemon is running. This is just a shortcut
-  for checking if the state is RUNNING, PAUSED or IDLE.
-   
-  This is typically used within your service_main method. See the
-  demo_daemon.rb file in the 'examples' directory for an example of how it's
-  used in practice.
-   
-Daemon#service_init
-  Any code defined defined within this method occurs before service_main is
-  reached. Any initialization code that takes more than two seconds to
-  execute should be placed here. Otherwise, your service may timeout when
-  you try to start it.
-  
-Daemon#service_main(*args)
-  You are expected to define your own service_main() method. The code
-  defined in this method is the code that will run while running as a
-  service.
-   
-  Any +args+ passed to Service.start are passed to this method.
-    
-Daemon#state
-  Returns the current state of the Daemon. For a list of valid states, see
-  the Constants section below.
-    
-= Signal Event Hooks
-  These methods are called if defined within your Daemon class, and the
-  appropriate signal is received by your service.
-
-Daemon#service_stop
-  Called if the service receives a SERVICE_CONTROL_STOP signal. This is
-  what the Service.stop() method sends.
-
-Daemon#service_pause
-  Called if the service receives a SERVICE_CONTROL_PAUSE signal. This is
-  what the Service.pause() method sends.
-    
-Daemon#service_resume
-  Called if the service receives a SERVICE_CONTROL_CONTINUE signal. This
-  is what the Service.resume() method sends.
-    
-Daemon#service_interrogate
-  Called if the service receives a SERVICE_CONTROL_INTERROGATE signal. This
-  notifies a service that it should report its current status information to
-  the service control manager.
-    
-Daemon#service_shutdown
-  Called if the service receives a SERVICE_CONTROL_SHUTDOWN signal.
-    
-Daemon#service_netbindadd
-  Called if the service receives a SERVICE_CONTROL_NETBINDADD signal. This
-  notifies a network service that there is a new component for binding.
-    
-Daemon#service_netbinddisable
-  Called if the service receives a SERVICE_CONTROL_NETBINDDISABLE signal.
-  This notifies a network service that one of its bindings has been
-  disabled.
-    
-Daemon#service_netbindenable
-  Called if the service receives a SERVICE_CONTROL_NETBINDENABLE signal.
-  This  Notifies a network service that a disabled binding has been enabled.
-
-Daemon#service_netbindremove
-  Called if the service receives a SERVICE_CONTROL_NETBINDREMOVE signal.
-  This notifies a network service that that a component for binding has
-  been removed.
-
-Daemon#service_paramchange
-  Called if the service receives a SERVICE_CONTROL_PARAMCHANGE signal.
-  This notifies a service that its startup parameters have changed.
-
-= Constants
-
-=== Service state constants
-Daemon::CONTINUE_PENDING
-  The service continue is pending.
-
-Daemon::PAUSE_PENDING
-  The service pause is pending.
-
-Daemon::PAUSED
-  The service is paused (but not STOPPED).
-
-Daemon::RUNNING
-  The service is running.
-
-Daemon::START_PENDING
-  The service is starting (but is not yet in a RUNNING state).
-
-Daemon::STOP_PENDING
-  The service is stopping (but is not yet in a STOPPED state).
-
-Daemon::STOPPED
-  The service is not running.
-   
-Daemon::IDLE
-  The service is running, in an idle state. This is a custom state that
-  we added that gets around a thread blocking issue.
-    
-= Notes
-  You must create a service before you can actually run it. Look in the
-  examples directory for the files 'demo_daemon.rb' and 'demodaemon_ctl.rb'.
-  They're small and straightforward examples of how to control, install and
-  setup your own Daemon.
-
-= Known Bugs
-  None known. Please report any bugs you find on the issue tracker at
-  https//github.com/djberg96/win32-service
-
-= Future Plans
-  None at this time.
-
-  Suggestions welcome. Please post them on the github project page at
-  https//github.com/djberg96/win32-service
-   
-= Acknowledgements
-  Many thanks go to Patrick Hurley for providing the fix for the thread
-  blocking issue for the original C code. Thanks also go to Kevin Burge for
-  his patch that solved service responsiveness issues.
-    
-= Copyright
-  (C) 2003-2016 Daniel J. Berger, All Rights Reserved
-
-= License
-  Artistic 2.0
-
-= Warranty
-  This package is provided "as is" and without any express or
-  implied warranties, including, without limitation, the implied
-  warranties of merchantability and fitness for a particular purpose.
-
-= Author(s)
-* Daniel J. Berger
-* Park Heesob

data/doc/service.txt

@@ -1,363 +0,0 @@
-= Description
-  An interface for MS Windows Services.
-    
-= Prerequisites
-  ffi 1.0 or later
-	
-  This library is only supported for the Windows NT family of operating
-  systems, e.g. 2000, XP, 2003, etc. It is NOT supported (and won't
-  work) for any version of DOS or Windows 95/98/ME. It is also not
-  supported on NT 4, as that platform is defunct.
-   
-  It should work on Windows XP Home, but is not officially supported for
-  that platform.
-    
-= Synopsis
-  require "win32/service"
-  include Win32
-    
-  # Create a new service
-  Service.create(
-    :service_name       => 'some_service', 
-    :service_type       => Service::WIN32_OWN_PROCESS,
-    :description        => 'A custom service I wrote just for fun'
-    :start_type         => Service::AUTO_START,
-    :error_control      => Service::ERROR_NORMAL,
-    :binary_path_name   => 'C:\path\to\some_service.exe',
-    :load_order_group   => 'Network',
-    :dependencies       => ['W32Time','Schedule']
-    :service_start_name => 'SomeDomain\\User',
-    :password           => 'XXXXXXX',
-    :display_name       => 'This is some service'
-  )
-    
-  # Configure a service that already exists
-  Service.configure(:display_name => "My Bar Service")
-    
-  Service.start("foo")
-  Service.pause("foo")
-  Service.resume("foo")
-  Service.stop("foo")
-    
-  Service.delete("foo")
-   
-  Service.get_display_name("Schedule") # "Task Scheduler"
-  Service.get_service_name("ClipBook") # "ClipSrv"
-   
-  Service.status('W32Time') => <struct Struct::ServiceStatus ...>
-    
-  # Enumerate over all services, inspecting each struct  
-  Service.services{ |s|
-    puts s.inspect
-  }
-    
-= Class Methods
-Service.new(options={})
-  Creates a new service. The +options+ parameter is a hash that can
-  contain any of the following parameters, and their default values:
-   
-  KEY               DEFAULT
-  * service_name       => nil (mandatory)
-  * host               => nil
-  * display_name       => service_name
-  * desired_access     => Service::ALL_ACCESS
-  * service_type       => Service::WIN32_OWN_PROCESS|Service::INTERACTIVE_PROCESS
-  * start_type         => Service::DEMAND_START
-  * error_control      => Service::ERROR_NORMAL
-  * binary_path_name   => nil
-  * load_order_group   => nil
-  * dependencies       => nil
-  * service_start_name => nil
-  * password           => nil
-  * description        => nil
-
-Service.configure(options={})   
-  Configures an existing service. The +options+ parameter is a hash that can
-  contain any of the following parameters:
-   
-  * service_name (mandatory)
-  * host
-  * service_type
-  * start_type
-  * error_control
-  * binary_path_name
-  * load_order_group
-  * dependencies
-  * service_start_name
-  * password (used with service_start_name)
-  * display_name
-  * description
-   
-Service.config_info(service, host=nil)
-  Returns a ServiceConfigInfo struct containing the configuration information
-  about +service+ on +host+, or the local host if no host is specified.
-   
-Service.create
-  Alias for Service.new
-    
-Service.delete(service, host=nil)
-  Deletes the specified +service+ on +host+.  If no host is given,
-  then it deletes it on the local machine.
-    
-Service.exists?(service)
-  Returns true if the specified service exists, false otherwise.
-    
-Service.pause(service, host=nil)
-  Pauses the specified +service+ on +host+, or the local machine if
-  no host is provided.
-    
-Service.resume(service, host=nil)
-  Resumes the specified +service+ on +host+, or the local machine if
-  no host is specified.
-    
-Service.services(host=nil, group=nil){ |struct| ... }
-  Enumerates over a list of service types on host, or the local
-  machine if no host is specified, yielding a Win32Service struct for each
-  service.
-
-  If a 'group' is specified, then only those services that belong to
-  that group are enumerated.  If an empty string is provided, then only
-  services that do not belong to any group are enumerated. If this parameter
-  is nil, group membership is ignored and all services are enumerated.
-	
-  The 'group' option is only available on Windows 2000 or later, and only
-  if compiled with VC++ 7.0 or later, or the .NET SDK.  The Win32Service
-  struct contains the following members:
-	
-  * service_name
-  * display_name
-  * service_type
-  * current_state
-  * controls_accepted
-  * win32_exit_code
-  * service_specific_exit_code
-  * check_point
-  * wait_hint
-  * binary_path_name
-  * start_type
-  * error_control
-  * load_order_group
-  * tag_id
-  * start_name
-  * dependencies
-  * description
-  * interactive?
-  * pid             (Win2k or later)
-  * service_flags   (Win2k or later)
-	
-  Note that the 'pid' and 'service_flags' members are only available on
-  Windows 2000 or later, and only if built with VC++ 7.0 or later (or the
-  .NET SDK).
-	
-Service.start(service, host=nil, *args)
-  Starts the specified +service+ on +host+, or the local machine if no
-  host is specified.  Any +args+ passed here are passed as start parameters
-  to the service.
-   
-Service.status(service)
-  Returns a Win32ServiceStatus struct for the specified service (or
-  raises a Win32::ServiceError if not found).  The Win32ServiceStatus
-  struct contains the following members.
-    
-  * service_type
-  * current_state
-  * controls_accepted
-  * win32_exit_code
-  * service_specific_exit_code
-  * check_point
-  * wait_hint
-  * interactive?
-    
-Service.stop(service, host=nil)
-  Stops the specified +service+ on +host+, or the local machine if no
-  host is specified.	
-    
-= Create and configure options
-binary_path_name
-  The binary to be used for the service. The path must be the fully
-  qualified path name. A path that contains a space must be quoted so that
-  it is correctly interpreted. The path may also include arguments to the
-  service entry point (typically the 'main' function).
-
-dependencies
-  Any dependencies the service has in order to run. This can be a string
-  or an array of strings.
-   
-description
-  A text string describing the service.
-        
-display_name
-  The display name to be used by user interface programs to identify the
-  service. The string has a maximum length of 256 characters. Case
-  sensitivity is preserved.
-    
-  The default is to set the display name to the same string as the
-  service name.
-   
-error_control
-  The error control for the service. The default is Service::ERROR_NORMAL.
-   
-  See the "Error Control Contants" section for available options and their
-  meanings.
-    
-load_order_group
-  The load order group, a string that names the load ordering group of
-  which this service is a member. The default is nil.
-    
-password
-  Sets the passsword to the account name specified in the Service#start_name
-  method.  By default, this value is set to nil, which is appropriate if
-  the account has no password or if the service runs in the
-  'LocalService', 'NetworkService', or 'LocalSystem' account.
-    
-  Note that passwords are ignored for driver services.
-    
-service_name
-  The service name for the service. This value must be set in order
-  to create a service. The string has a maximum length of 256 characters.
-    
-service_type
-  The service type for the service. The default is
-  Service::WIN32_OWN_PROCESS | Service::INTERACTIVE_PROCESS.
-
-  See the "Service Type Contants" section for available options and their
-  meanings.
-    
-start_name
-  Sets the name of the account under which the service should run.
-  By default the 'LocalSystem' account is used.
-    
-start_type
-  The start type for the service. The default is Service::DEMAND_START.
-    
-  See the "Start Type Contants" section for available options and their
-  meanings.
-    
-= Constants
-
-=== Standard Constants
-VERSION
-  The current version number of this package, returned as a string.
-    
-=== Desired Access Constants
-Service::MANAGER_ALL_ACCESS
-  Includes STANDARD_RIGHTS_REQUIRED, in addition to all access rights 
-  in the table.
-    
-Service::MANAGER_CREATE_SERVICE
-  Required to call the CreateService function to create a service object
-  and add it to the database.
-    
-Service::MANAGER_CONNECT
-  Required to connect to the service control manager.
-    
-Service::MANAGER_ENUMERATE_SERVICE
-  Required to call the EnumServicesStatus function to list the services
-  that are in the database.
-    
-Service::MANAGER_LOCK
-  Required to call the LockServiceDatabase function to acquire a lock on the
-  database.
-    
-Service::MANAGER_BOOT_CONFIG
-  Required to call the NotifyBootConfigStatus() (internal) function.  Not
-  defined with all compilers.
-    
-Service::MANAGER_QUERY_LOCK_STATUS
-  Required to call the QueryServiceLockStatus() (internal) function to
-  retrieve the lock status information for the database.
-       
-=== Service Type Constants
-Service::FILE_SYSTEM_DRIVER
-  File system driver service.
-    
-Service::KERNEL_DRIVER
-  Driver service.
-    
-Service::WIN32_OWN_PROCESS
-  Service that runs in its own process.
-    
-Service::WIN32_SHARE_PROCESS
-  Service that shares a process with one or more other services.
-    
-Service::INTERACTIVE_PROCESS
-  The service can interact with the desktop.  This can only be used if
-  either SERVICE_WIN32_OWN_PROCESS or SERVICE_WIN32_SHARE_PROCESS is
-  specified as well, and the service is running in the context of the
-  LocalSystem account (which is the default for this module, btw).
-    
-=== Start Type Constants
-Service::AUTO_START
-  A service started automatically by the service control manager during
-  system startup.
-    
-Service::BOOT_START
-  A device driver started by the system loader.  This value is valid only
-  for driver services.
-    
-Service::DEMAND_START
-  A service started by the service control manager when a process calls
-  the StartService() function.
-    
-Service::DISABLED
-  A service that cannot be started.  Attempts to start the service result
-  in an error.
-    
-Service::SYSTEM_START
-  A device driver started by the IoInitSystem() function.  This value is
-  valid only for driver services.
-    
-=== Error Control Constants
-Service::ERROR_IGNORE
-  The startup program logs the error but continues the startup operation.
-    
-Service::ERROR_NORMAL
-  The startup program logs the error and puts up a message box pop-up but
-  continues the startup operation.
-    
-Service::ERROR_SEVERE
-  The startup program logs the error.  If the last-known-good configuration
-  is being started, the startup operation continues.  Otherwise, the system
-  is restarted with the last-known-good configuration.
-   
-Service::ERROR_CRITICAL
-  The startup program logs the error, if possible.  If the last-known-good
-  configuration is being started the startup operation fails.  Otherwise,
-  the system is restarted with the last-known-good configuration.
-    
-= Notes
-  See the MSDN API with regards to CreateService(), etc at http://www.msdn.com.
-    
-  Some API ideas taken (or not) from both Python's win32serviceutil.py and
-  Perl's Win32::Service module.
-   
-  I don't truly understand how to allow a tag_id in the create_service()
-  method, so for now it's set to NULL automatically. Suggestions welcome.
-    
-= Known Bugs
-  There may be a failure in the test suite if the W32Time dependency is
-  not started.
-
-  If you find any bugs please log them on the github project page at
-  https://github.com/djberg96/win32-service
-   
-= Acknowledgements
-  Many thanks go to Patrick Hurley for providing the fix for the thread
-  blocking issue in the original C code. Thanks also go to Kevin Burge for
-  his patch that solved service responsiveness issues.
-    
-= Future Plans
-  Add Tag_ID support.
-  Add ability to create or modify service failure actions.
-    
-= Copyright
-  (C) 2003-2016, Daniel J. Berger, All Rights Reserved
-    
-= Warranty
-  This package is provided "as is" and without any express or
-  implied warranties, including, without limitation, the implied
-  warranties of merchantability and fitness for a particular purpose.
-    
-== Authors
-* Daniel J. Berger   
-* Park Heesob