win32-service 0.7.2-x86-mingw32

data/CHANGES

@@ -0,0 +1,254 @@
+== 0.7.2 - 7-Sep-2011
+* Now works with mingw compiler by skipping __try and __finally if using
+  mingw, or using them with mingw if the seh.h header is found.
+* The binary gem now contains binaries for both Ruby 1.8.7 and 1.9.2 using
+  a simple wrapper.
+* Updated some Rake tasks.
+
+== 0.7.1 - 9-Feb-2010
+* Compatibility fixes for 1.9.x.
+* Fixed a bug where the controls_accepted struct member was always nil. This
+  has been fixed and now always returns an array.
+* Added 'pre-shutdown' as possible values for the list of controls accepted.
+* Changed test-unit from a runtime dependency to a development dependency.
+* Some tests were refactored to be more reliable.
+* Refactored the Rakefile and gemspec.
+
+== 0.7.0 - 30-Jun-2009
+* INTERFACE CHANGE: The Service.new and Service.configure methods now accept
+  a single hash argument only. The :service_name key is mandatory, while the
+  :host key is optional.
+* Fixed a bug in the Service.services method where a segfault would occur if
+  the binary_path_name was greater than 260 characters. The buffer size has
+  been increased to 1024 characters. Thanks go to Dan Daniels for the spot.
+* Altered the Daemon class so that the Ruby interpreter was not invoked within
+  the Service_Main function. The functions that close stdin, stdout and stderr
+  are now called within the mainloop method. Thanks go to Tim Hanson for the
+  spot and the patch.
+* Eliminated a minor build warning in daemon.c
+* License changed to Artistic 2.0, with corresponding gemspec update.
+* Added an uninstall rake task.
+* Updated the service_stop method in the demo_daemon.rb file, and added some
+  additional comments.
+* The test files were renamed.
+* Several tests were updated and refactored to use Test::Unit 2.x. That
+  library is now a dependency.
+* The 'uninstall' Rakefile task is now more verbose.
+
+== 0.6.1 - 1-Jan-2008
+* The Service.services method now handles the scenario where a particular
+  service may still exist, but its underlying registry entry has been deleted.
+  In this case, most ServiceInfo struct members are set to nil and a warning
+  is issued.
+* RDoc updates.
+
+== 0.6.0 - 25-Nov-2007
+* The Service control class is now pure Ruby. The Daemon class is still C,
+  however. That may change in the future. This means the windows-pr
+  library is now a prerequisite.
+* The Service.new method has been altered in a way that is not backwards
+  compatible. It is now the same as Service.create.
+* The Service.start method now properly handles arguments to the
+  Daemon#service_main method.
+* The Daemon source code is now separate from the Service control class
+  source code. That means you must require them separately, as needed.
+* The Daemon class should be much more responsive to service events now,
+  especially service_stop. Many thanks go to Kevin Burge for the patch.
+* Added the Daemon.mainloop method as a shortcut for Daemon.new.mainloop.
+* The Daemon class now redirects STDIN, STDOUT and STDERR to the NUL device
+  if they're still associated with a terminal when the service starts. This
+  should help prevent Errno::EBADF errors.
+* The Service.services class method now supports the group parameter for
+  versions of Ruby built with older compilers, i.e. it will now work with
+  the one-click Ruby installer.
+* The Service.getdisplayname method was changed to Service.get_display_name.
+  An alias has been provided for backwards compatibility.
+* The Service.getservicename method was changed to Service.get_service_name.
+  An alias has been provided for backwards compatibility.
+* Added the Service.config_info method.
+* The Service.create and Service.configure methods now allow you to set
+  failure actions, failure commands, and reset/retry periods.
+* Improved test suite.
+* Changed 'tdaemon.rb', 'tdaemon_ctl.rb' and 'service_test.rb' to
+  'demo_daemon.rb', 'demo_daemon_ctl.rb' and 'demo_services.rb', respectively.
+* Some refactoring and updates to the demo daemon and demo daemon controller
+  examples.
+* The Win32Service struct is now ServiceInfo.
+* ServiceError is now Service::Error.
+* DaemonError is now Daemon::Error.
+* Some documentation improvements, corrections and updates.
+
+== 0.5.2 - 25-Nov-2006
+* Fixed a bug in the Daemon class where the service event handling methods
+  (most notably service_stop) did not work properly due to thread blocking
+  issues.  Many thanks go to Patrick Hurley for the patch.
+* Added the Daemon#running? method as helper method for your service_main
+  method.
+* The 'interactive?' struct member is now just 'interactive'.  This was
+  supposed to have been in the last release but was somehow missed.  Sorry.
+* Scrapped the old daemon_test.rb file and split it into two new files -
+  tdaemon.rb and tdaemon_ctl.rb.  In the process a few bugs were fixed.
+* Added a gemspec.
+* Documentation and test suite updates.
+
+== 0.5.1 - 18-Jun-2006
+* Added the Service.open method.
+* The Service.new method now accepts a block, and automatically closes itself
+  at the end of the block.
+* Fixed in a bug in the Service.create method where setting dependencies
+  was not working properly.  Thanks go to Scott Harper for the spot.
+* The 'interactive?' struct member is now just 'interactive' since Ruby no
+  longer supports question marks in struct member names.  UGH.
+* The block for Service#configure_service is no longer optional.
+* Replaced ClipSrv with W32Time for most of the test methods in tc_service.rb
+  because it had a dependency that is disabled on most systems.
+* Added a tweak to the extconf.rb file to help with the test suite.
+* Some documentation updates and corrections.
+
+== 0.5.0 - 26-Nov-2005
+* Added a service_init hook, and (internally) altered the way the service
+  starts.  This was done to deal with services that need to perform any
+  initialization in the Daemon itself before the service starts.  Previously
+  this would result in the service timing out during startup.
+  
+  Thanks go to Jamey Cribbs for spotting the problem.
+  
+* Modified the Daemon example, adding a service_init hook that does about 10
+  seconds worth of initialization before finally starting.  See the comments
+  in examples\daemon_test.rb for more information.
+* Minor test and README changes.
+
+== 0.4.6 - 24-May-2005
+* Fixed an initialization bug that could cause Daemons to fail unless the
+  win32-service package was the last package require'd.
+* Altered the Service.start method.  It now takes any number of arguments
+  (after the service and host name).  These arguments are passed to the
+  service's Service_Main() function.
+* The Service.services method now returns an Array of ServiceStruct's in
+  non-block form.
+* The Service.start, Service.pause, Service.resume, Service.stop and
+  Service.delete methods now return the class (self), not 'true'.
+* Added the ability to add or configure the service description in
+  Service#create_service or Service#configure, respectively.
+* Fixed a bug in the Service.start method where false positives could result.
+* Updated the ServiceStatus struct to include pid and service_flags on Win2k
+  or later.
+* Unicode is now the default setting as far as internal string handling.  It
+  will still work fine with 'regular' text.
+* Added safe string handling for string input values.
+* Added rdoc comments into the C source.
+* Made the service.txt and daemon.txt files rdoc friendly.
+* Removed the service.rd and daemon.rd files.  If you want html documentation,
+  run rdoc over the service.txt and daemon.txt files.
+* The dreaded "code cleanup".
+
+== 0.4.5 - 28-Feb-2005
+* Fixed an accessor bug in Service#create.  Thanks go to Nathaniel Talbott
+  for the spot.
+* Eliminated a warning that appeared starting in Ruby 1.8.2 regarding Struct
+  redefinitions.
+* Moved 'examples' directory to toplevel directory.
+* Deleted the 'test2.rb' example.  This was supplanted by the 'daemon_test.rb'
+  script.
+* Renamed the 'test.rb' file to 'services_test.rb'.
+* Made this document rdoc friendly.
+
+== 0.4.4 - 27-Aug-2004
+* Modified the Service class to use the newer allocation framework.  The
+  Daemon class already used this, hence no major version bump.
+* Fixed in a bug in the create_service() method with regards to the
+  'dependencies' option and null arguments (you no longer need to specify
+  an empty array).
+
+== 0.4.3 - 14-Aug-2004
+* Fixed the Daemon class by adding back the constants it needed in order to
+  run.  I accidentally broke this when I changed the Daemon class from being
+  a subclass of Service to being its own class.
+* Added a separate test suite for the Daemon class, tc_daemon.rb, to help
+  me from making that mistake ever again. :)
+* Updated the daemon_test.rb script a bit to report error messages should
+  any occur.
+* Minor doc updates
+
+== 0.4.2 - 10-Jul-2004
+* The Daemon class is no longer a subclass of Service.
+* Added the 'pid' and 'service_flags' struct members to the Win32Service
+  struct.  These members are only available to folks using Windows 2000 or
+  later and who compile with VC++ 7.0 or later (including the .NET SDK).
+* The Service.services method now accepts a group name as an optional third
+  argument.  Again, you must be using Windows 2000 or later and compile with
+  VC++ 7.0 or later (including the .NET SDK).
+* The deprecated STR2CSTR() functions were replaced with StringValuePtr().
+  This also means that as of this version, win32-service requires Ruby
+  1.8.0 or greater.
+* Moved the sample programs to doc/examples
+* Removed the .html files under /doc.  You can generate that on your own if
+  you like.
+
+== 0.4.1 - 14-Mar-2004
+* Added the exists? class method and corresponding test suite additions.
+* Pushed the ServiceError and DaemonError classes under the Win32 module.
+* Normalized tc_service.rb so that it can be run outside of the test directory
+  more easily.
+
+== 0.4.0 - 9-Feb-2004
+* Changed "worker" method to "service_main" method.
+* Added event hooks for stop, pause, resume, etc.  See the documentation for
+  further details.  (Thanks Park Heesob)
+* Some of the Daemon functions were raising ServiceError.  They have been
+  changed to DaemonError.
+* Updated the daemon_test.rb file to use the new event hooks.
+* Documentation additions and updates.
+
+== 0.3.0 - 31-Jan-2004
+* Added a Daemon subclass.  This allows you to run Ruby programs as a service.
+  Please see the documentation for more details. (Thanks Park Heesob).  This
+  should be considered an ALPHA release.
+* The Win32ServiceError class has been renamed to just ServiceError.  I felt
+  the "Win32" was redundant, given that it's already under the Win32 module.
+* In some cases a bogus error description was being returned because the
+  GetLastError() function was being called too late.  This has been fixed.
+  (Thanks Park Heesob).
+* The explicit garbage collection has been removed because what I thought was
+  a memory leak was not, in fact, a memory leak.  In addition, it was hurting
+  performance badly.
+* The "\r\n" is now automatically stripped from error messages.  This was
+  causing slightly garbled error messages.  (Thanks Park Heesob).
+* Added explicit closing of the Service Control Manager handle in the
+  services() function for those rare cases where it may fail while reading
+  service information.
+* Made some of the error strings a bit more descriptive.
+* Test suite and documentation additions, including a sample daemon program
+  in the test directory called "daemon_test.rb".
+
+== 0.2.2 - 15-Jan-2004
+* Fixed a mistake in the service_init declaration within Init_service().
+* Fixed bug in the service_init function with regards to desired access.
+* Modified service_free() function to explicitly set the hSCManager handle
+  to NULL and modified the service_close() method to test hSCManager handle
+  for NULL value.  This should eliminate accidentally trying to close an
+  already closed handle, which may have happened as the result of a free()
+  call. (Thanks Park Heesob).
+* Added explicit garbage collection in Service.services() method.
+* More explicit about closing open HANDLE's when error conditions arise.
+
+== 0.2.1 - 2-Nov-2003
+* Made the exported less redundant and less verbose, e.g.
+  Service::SERVICE_DISABLED is now just Service::DISABLED.  The same is true
+  for the service control constants, i.e. the 'SC_' has been removed.
+* Corresponding test suite changes.
+
+== 0.2.0 - 16-Oct-2003
+* The constructor has been changed.  It now only takes a machine name and a
+  desired access for arguments.  The keyword arguments are now part of the
+  create_service method() and only in block form.  See the documentation for
+  more details.
+* Added a configure_service() and close() instance methods.
+* Added several new constants to allow finer control over created and
+  configured services.
+* Added Win32ServiceError as an exception.  All failures now raise this
+  error instead of a vanilla StandardError.
+* Moved some common code into the service.h file.
+
+== 0.1.0 - 10-Oct-2003
+- Initial release

data/MANIFEST

@@ -0,0 +1,19 @@
+* MANIFEST
+* CHANGES
+* README
+* Rakefile
+* win32-service.gemspec
+* doc/daemon.txt
+* doc/service.txt
+* ext/extconf.rb
+* ext/win32/daemonc.c
+* examples/demo_daemon.rb
+* examples/demo_daemon_ctl.rb
+* examples/demo_services.rb
+* lib/win32/service.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

@@ -0,0 +1,71 @@
+== Description
+  The win32-service library allows you to control or create MS Windows services.
+
+== Installation
+  gem install win32-service                        # Build from source
+  gem install win32-service --platform x86-mingw32 # Install binary
+
+== Synopsis
+  require 'win32/service'
+
+  # Iterate over the available services
+  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'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
+  Pure Ruby Daemon class
+  Add service_session_change hook
+
+== Copyright
+  (C) 2003-2011, 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

@@ -0,0 +1,179 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rbconfig'
+include Config
+
+CLEAN.include(
+  '**/*.gem',    # Gem files
+  '**/*.rbc',    # Rubinius
+  '**/*.o',      # C object file
+  '**/*.log',    # Ruby extension build log
+  '**/Makefile', # C Makefile
+  "**/*.so",     # C shared object
+  "**/*.lib",    # C build file
+  "**/*.def",    # C build file
+  "**/*.pdb",    # C build file
+  "**/*.exp",    # C build file
+  "**/*.obj",    # C build file
+  "**/*.log",    # C build file
+  "lib/win32/ruby18", "lib/win32/ruby19", "lib/win32/daemon.rb"
+)
+
+desc "Build the win32-service library"
+task :build => [:clean] do
+  make = CONFIG['host_os'] =~ /mingw|cygwin/i ? "make" : "nmake"
+
+  Dir.chdir('ext') do
+    ruby 'extconf.rb'
+    sh "#{make}"
+    FileUtils.cp('daemon.so', 'win32/daemon.so')      
+  end  
+end
+
+namespace 'gem' do
+  desc 'Build the gem'
+  task :create => [:clean] do
+    spec = eval(IO.read('win32-service.gemspec')) 
+    Gem::Builder.new(spec).build
+  end
+
+  desc 'Install the gem'
+  task :install => [:create] do
+    file = Dir['*.gem'].first
+    sh "gem install #{file}"
+  end
+
+  desc 'Build a binary gem'
+  task :binary => [:build] do
+    mkdir_p 'lib/win32'
+    mv 'ext/win32/daemon.so', 'lib/win32/daemon.so'
+
+    spec = eval(IO.read('win32-service.gemspec'))
+    spec.extensions = nil
+    spec.platform = Gem::Platform::CURRENT
+
+    spec.files = spec.files.reject{ |f| f.include?('ext') }
+
+    Gem::Builder.new(spec).build
+  end
+
+  # This is for me, not for you.
+  desc 'Create a gem with binaries for 1.8 and 1.9'
+  task :binaries => [:clean] do
+    make = CONFIG['host_os'] =~ /mingw|cygwin/i ? "make" : "nmake"
+
+    mkdir_p "lib/win32/ruby18"
+    mkdir_p "lib/win32/ruby19"
+
+    Dir.chdir('ext') do
+      # Ruby 1.8
+      sh "C:\\ruby187\\bin\\ruby extconf.rb"
+      sh "#{make}"
+      mv 'daemon.so', '../lib/win32/ruby18'
+      sh "#{make} distclean"
+
+      # Ruby 1.9
+      sh "C:\\ruby192\\bin\\ruby extconf.rb"
+      sh "#{make}"
+      mv 'daemon.so', '../lib/win32/ruby19'
+    end
+
+    File.open("lib/win32/daemon.rb", "w"){ |fh|
+      fh.puts "if RUBY_VERSION.to_f >= 1.9"
+      fh.puts "  require 'win32/ruby19/daemon'"
+      fh.puts "else"
+      fh.puts "  require 'win32/ruby18/daemon'"
+      fh.puts "end"
+    }
+
+    spec = eval(IO.read('win32-service.gemspec'))
+    spec.extensions = nil
+    spec.platform = Gem::Platform::CURRENT
+
+    spec.files = spec.files.reject{ |f| f.include?('ext') }
+
+    spec.files += [
+      'lib/win32/daemon.rb',
+      'lib/win32/ruby18/daemon.so',
+      'lib/win32/ruby19/daemon.so'
+    ]
+
+    Gem::Builder.new(spec).build
+  end
+end
+
+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|
+    task :all => :build
+    t.libs << 'ext'
+    t.verbose = true
+    t.warning = true
+  end
+
+  desc 'Run the tests for the Win32::Daemon class'
+  Rake::TestTask.new('daemon') do |t|
+    task :daemon => :build
+    t.libs << 'ext'
+    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'