win32-eventlog 0.4.9 → 0.5.0

data/CHANGES

@@ -1,3 +1,14 @@
+= 0.5.0 - 12-Sep-2008
+* Fixed an issue for Windows Vista and later where some event descriptions
+  were missing. This fix requires windows-pr 0.9.3 or later.
+* The EventLog#full? method now raises an EventLog::Error if it should fail
+  instead of a StandardError.
+* Minor tweak to mc.rb - chomp the input file name if run as a program.
+* Added test-unit 2.0.0 or later as a dependency.
+* Added ptools as a dependency for the sake of the test suite.
+* Renamed the test files to start with 'test_'.
+* Removed the ts_all.rb file.
+
 = 0.4.9 - 7-Sep-2008
 * The private get_description method, which is used internally to read the
   event log, has been updated to work with 64 bit Windows. The changes needed

data/MANIFEST

@@ -12,6 +12,5 @@
 * misc/install_msg.rb
 * misc/rubymsg.mc
 * test/foo.mc
-* test/ts_all.rb
-* test/tc_eventlog.rb
-* test/tc_mc.rb
+* test/test_eventlog.rb
+* test/test_mc.rb

data/README

@@ -8,7 +8,7 @@
 
 = Prerequisites
    Ruby 1.8.2 or later.
-   windows-pr 0.5.0 or later.
+   windows-pr 0.9.3 or later.
    
    The 'mc', 'rc' and 'link' command line tools are required to create and
    install message sources. You won't need these for simply reading from or
@@ -50,9 +50,7 @@
    them somewhere on your system.
 
 = Known Issues
-   Not all event descriptions from Windows Vista/2008 or later will necessarily
-   be picked up because of a new event logging format and api that Microsoft
-   has introduced. This will be addressed in the next major release.
+   None known.
 
    Please file any bug reports on the project page at
    http://www.rubyforge.org/projects/win32utils.

data/Rakefile

@@ -17,7 +17,6 @@ task :install_gem do
 end
 
 Rake::TestTask.new do |t|
-   t.libs << 'lib'
    t.warning = true
-   t.test_files = FileList['test/ts*']
+   t.verbose = true
 end

data/lib/win32/eventlog.rb

@@ -38,7 +38,7 @@ module Win32
       extend Windows::Registry
       
       # The version of the win32-eventlog library
-      VERSION = '0.4.9'
+      VERSION = '0.5.0'
       
       # Aliased read flags
       FORWARDS_READ   = EVENTLOG_FORWARDS_READ
@@ -405,7 +405,7 @@ module Win32
          needed = [0].pack('L')
          
          unless GetEventLogInformation(@handle, 0, buf, buf.size, needed)
-            raise 'GetEventLogInformation() failed: ' + get_last_error
+            raise Error, 'GetEventLogInformation() failed: ' + get_last_error
          end
 
          buf[0,4].unpack('L')[0] != 0
@@ -827,7 +827,7 @@ module Win32
       # buffer.
       #      
       def get_description(rec, event_source, lkey)
-         str     = rec[rec[36,4].unpack('L')[0] .. -1]        
+         str     = rec[rec[36,4].unpack('L')[0] .. -1]
          num     = rec[26,2].unpack('S')[0] # NumStrings
          hkey    = [0].pack('L')
          key     = BASE_KEY + "#{@source}\\#{event_source}"
@@ -839,75 +839,199 @@ module Win32
                old_wow_val = 0.chr * 4
                Wow64DisableWow64FsRedirection(old_wow_val)
             end
-      
+
+            param_exe = nil
+            message_exe = nil
+
             if RegOpenKeyEx(lkey, key, 0, KEY_READ, hkey) == 0
-               value = 'ParameterMessageFile'
-               file  = 0.chr * MAX_SIZE
                hkey  = hkey.unpack('L')[0]
-               size  = [ file.length].pack('L')
-                    
-               if RegQueryValueEx(hkey, value, 0, 0, file, size) == 0
-                  file = file.nstrip
-                  exe  = 0.chr * MAX_SIZE               
+
+               value = 'providerGuid'
+               guid  = 0.chr * MAX_SIZE
+               size  = [ guid.length].pack('L')
+
+               if RegQueryValueEx(hkey, value, 0, 0, guid, size) == 0
+                  guid  = guid.nstrip
+                  hkey2 = [0].pack('L')
+                  key   = "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\"
+                  key   << "WINEVT\\Publishers\\#{guid}"
+                 
+                  if RegOpenKeyEx(lkey, key, 0, KEY_READ|0x100, hkey2) == 0
+                     hkey2  = hkey2.unpack('L')[0]
+                     value = 'ParameterMessageFile'
+                     file  = 0.chr * MAX_SIZE
+                     size  = [ file.length].pack('L')
+
+                     if RegQueryValueEx(hkey2, value, 0, 0, file, size) == 0
+                        file = file.nstrip
+                        exe  = 0.chr * MAX_SIZE
+                        ExpandEnvironmentStrings(file, exe, exe.size)
+                        param_exe = exe.nstrip
+                     end
+                  
+                     value = 'MessageFileName'
+                     file  = 0.chr * MAX_SIZE
+                     size  = [file.length].pack('L')
+
+                     if RegQueryValueEx(hkey2, value, 0, 0, file, size) == 0
+                        file = file.nstrip
+                        exe  = 0.chr * MAX_SIZE
+                        ExpandEnvironmentStrings(file, exe, exe.size)
+                        message_exe = exe.nstrip
+                     end
+                     
+                     RegCloseKey(hkey2)
+                  end
+               else
+                  value = 'ParameterMessageFile'
+                  file  = 0.chr * MAX_SIZE
+                  size  = [ file.length].pack('L')
+
+                  if RegQueryValueEx(hkey, value, 0, 0, file, size) == 0
+                     file = file.nstrip
+                     exe  = 0.chr * MAX_SIZE
+                     ExpandEnvironmentStrings(file, exe, exe.size)
+                     param_exe = exe.nstrip
+                  end
+
+                  value = 'EventMessageFile'
+                  file  = 0.chr * MAX_SIZE
+                  size  = [file.length].pack('L')
+
+                  if RegQueryValueEx(hkey, value, 0, 0, file, size) == 0
+                     file = file.nstrip
+                     exe  = 0.chr * MAX_SIZE
+                     ExpandEnvironmentStrings(file, exe, exe.size)
+                     message_exe = exe.nstrip
+                   end
+                end
+                 
+                RegCloseKey(hkey)
+            elsif defined? EvtOpenPublisherMetadata # Vista or later
+               pubMetadata = EvtOpenPublisherMetadata(
+                  0,
+                  multi_to_wide(event_source),
+                  0,
+                  1024, # Default LCID
+                  0
+               )
+              
+               if pubMetadata > 0
+                  buf2 = 0.chr * 8192
+                  val  = 0.chr*4
+                 
+                  EvtGetPublisherMetadataProperty(
+                     pubMetadata,
+                     2, # EvtPublisherMetadataParameterFilePath
+                     0,
+                     8192,
+                     buf2,
+                     val
+                  )
+                 
+                  file = wide_to_multi(buf2[16..-1])
+                  exe  = 0.chr * MAX_SIZE
                   ExpandEnvironmentStrings(file, exe, exe.size)
-                  exe = exe.nstrip
+                  param_exe = exe.nstrip
+
+                  buf2 = 0.chr * 8192
+                  val = 0.chr*4
                   
-                  va_list = va_list0.map{ |v|
-                     va = v
+                  EvtGetPublisherMetadataProperty(
+                     pubMetadata,
+                     3, # EvtPublisherMetadataMessageFilePath
+                     0,
+                     8192,
+                     buf2,
+                     val
+                  )
                   
-                     v.scan(/%%(\d+)/).uniq.each{ |x|
-                        exe.split(';').each{ |file|             
-                           hmodule  = LoadLibraryEx(
-                              file,
+                  file = wide_to_multi(buf2[16..-1])
+                  exe  = 0.chr * MAX_SIZE
+                  ExpandEnvironmentStrings(file, exe, exe.size)
+                  message_exe = exe.nstrip
+                  EvtClose(pubMetadata)
+               end
+            end
+
+            if param_exe != nil
+               va_list = va_list0.map{ |v|
+                  va = v
+
+                  v.scan(/%%(\d+)/).uniq.each{ |x|
+                     param_exe.split(';').each{ |file|
+                        hmodule  = LoadLibraryEx(
+                           file,
+                           0,
+                           DONT_RESOLVE_DLL_REFERENCES |
+                           LOAD_LIBRARY_AS_DATAFILE
+                        )
+
+                        if hmodule != 0
+                           res = FormatMessage(
+                              FORMAT_MESSAGE_FROM_HMODULE |
+                              FORMAT_MESSAGE_ARGUMENT_ARRAY,
+                              hmodule,
+                              x.first.to_i,
                               0,
-                              DONT_RESOLVE_DLL_REFERENCES |
-                              LOAD_LIBRARY_AS_DATAFILE
+                              buf,
+                              buf.size,
+                              v
                            )
-                           
-                           if hmodule != 0
-                              FormatMessage(
+                  
+                           if res == 0
+                              event_id = 0xB0000000 | event_id
+                              res = FormatMessage(
                                  FORMAT_MESSAGE_FROM_HMODULE |
-                                 FORMAT_MESSAGE_ARGUMENT_ARRAY,
+                                 FORMAT_MESSAGE_IGNORE_INSERTS,
                                  hmodule,
-                                 x.first.to_i,
+                                 event_id,
                                  0,
                                  buf,
                                  buf.size,
-                                 v
+                                 nil
                               )
-                              FreeLibrary(hmodule)
-                              break if buf.nstrip != ""
                            end
-                        }
-                        va = va.gsub("%%#{x.first}", buf.nstrip)     
+
+                           FreeLibrary(hmodule)
+                           break if buf.nstrip != ""
+                        end
                      }
-                     va
+                     va = va.gsub("%%#{x.first}", buf.nstrip)
                   }
-               end
-             
-               value = 'EventMessageFile'
-               file  = 0.chr * MAX_SIZE
-               size  = [file.length].pack('L')
-                    
-               if RegQueryValueEx(hkey, value, 0, 0, file, size) == 0
-                  file = file.nstrip
-                  exe  = 0.chr * MAX_SIZE
-                       
-                  ExpandEnvironmentStrings(file, exe, exe.size)
-                  exe = exe.nstrip
-          
-                  # Try to retrieve message *without* expanding the inserts yet
-                  exe.split(';').each{ |file|
-                     hmodule = LoadLibraryEx(
-                        file,
+                  va
+               }
+            end
+
+            if message_exe != nil
+               buf  = 0.chr * 8192 # Reset the buffer
+
+               # Try to retrieve message *without* expanding the inserts yet
+               message_exe.split(';').each{ |file|
+                  hmodule = LoadLibraryEx(
+                     file,
+                     0,
+                     DONT_RESOLVE_DLL_REFERENCES | LOAD_LIBRARY_AS_DATAFILE
+                  )
+
+                  event_id = rec[20,4].unpack('L')[0]
+                  
+                  if hmodule != 0
+                     res = FormatMessage(
+                        FORMAT_MESSAGE_FROM_HMODULE |
+                        FORMAT_MESSAGE_IGNORE_INSERTS,
+                        hmodule,
+                        event_id,
                         0,
-                        DONT_RESOLVE_DLL_REFERENCES | LOAD_LIBRARY_AS_DATAFILE
+                        buf,
+                        buf.size,
+                        nil
                      )
-
-                     event_id = rec[20,4].unpack('L')[0]
-                     
-                     if hmodule != 0
-                        FormatMessage(
+                  
+                     if res == 0
+                        event_id = 0xB0000000 | event_id
+                  
+                        res = FormatMessage(
                            FORMAT_MESSAGE_FROM_HMODULE |
                            FORMAT_MESSAGE_IGNORE_INSERTS,
                            hmodule,
@@ -917,39 +1041,52 @@ module Win32
                            buf.size,
                            nil
                         )
-                             
-                        FreeLibrary(hmodule)
-                        break if buf.nstrip != "" # All messages read
                      end
-                  }
                   
-                  buf  = 0.chr * 8192 # Reset the buffer
-               
-                  # Determine higest %n insert number
-                  max_insert = [num, buf.nstrip.scan(/%(\d+)/).map{ |x| x[0].to_i }.max].compact.max
-
-                  # Insert dummy strings not provided by caller
-                  ((num+1)..(max_insert)).each{ |x| va_list.push("%#{x}") }
-         
-                  if num == 0
-                     va_list_ptr = 0.chr * 4
-                  else
-                     va_list_ptr = va_list.map{ |x|
-                        [x + 0.chr].pack('P').unpack('L')[0]
-                     }.pack('L*')
+                     FreeLibrary(hmodule)
+                     break if buf.nstrip != "" # All messages read
                   end
-         
-                  exe.split(';').each{ |file|
-                     hmodule = LoadLibraryEx(
-                        file,
+               }
+
+               # Determine higest %n insert number
+               max_insert = [num, buf.nstrip.scan(/%(\d+)/).map{ |x| x[0].to_i }.max].compact.max
+
+               # Insert dummy strings not provided by caller
+               ((num+1)..(max_insert)).each{ |x| va_list.push("%#{x}") }
+
+               if num == 0
+                  va_list_ptr = 0.chr * 4
+               else
+                  va_list_ptr = va_list.map{ |x|
+                     [x + 0.chr].pack('P').unpack('L')[0]
+                  }.pack('L*')
+               end
+                  
+               message_exe.split(';').each{ |file|
+                  hmodule = LoadLibraryEx(
+                     file,
+                     0,
+                     DONT_RESOLVE_DLL_REFERENCES | LOAD_LIBRARY_AS_DATAFILE
+                  )
+
+                  event_id = rec[20,4].unpack('L')[0]
+
+                  if hmodule != 0
+                     res = FormatMessage(
+                        FORMAT_MESSAGE_FROM_HMODULE |
+                        FORMAT_MESSAGE_ARGUMENT_ARRAY,
+                        hmodule,
+                        event_id,
                         0,
-                        DONT_RESOLVE_DLL_REFERENCES | LOAD_LIBRARY_AS_DATAFILE
+                        buf,
+                        buf.size,
+                        va_list_ptr
                      )
-
-                     event_id = rec[20,4].unpack('L')[0]
                   
-                     if hmodule != 0
-                        FormatMessage(
+                     if res == 0
+                        event_id = 0xB0000000 | event_id
+                  
+                        res = FormatMessage(
                            FORMAT_MESSAGE_FROM_HMODULE |
                            FORMAT_MESSAGE_ARGUMENT_ARRAY,
                            hmodule,
@@ -959,21 +1096,20 @@ module Win32
                            buf.size,
                            va_list_ptr
                         )
-                             
-                        FreeLibrary(hmodule)
-                        break if buf.nstrip != "" # All messages read
                      end
-                  }
-               end
-               RegCloseKey(hkey)
-            end
-         ensure
-            if defined? Wow64RevertWow64FsRedirection
-               Wow64RevertWow64FsRedirection(old_wow_val.unpack('L')[0])
+
+                     FreeLibrary(hmodule)
+                     break if buf.nstrip != "" # All messages read
+                  end
+               }
             end
-         end
+        ensure
+           if defined? Wow64RevertWow64FsRedirection
+              Wow64RevertWow64FsRedirection(old_wow_val.unpack('L')[0])
+           end
+        end
 
-         [va_list0, buf.strip]
-      end      
+        [va_list0, buf.nstrip]
+     end      
    end
-end
+end

data/lib/win32/mc.rb

@@ -2,7 +2,7 @@ module Win32
    class MC
       class Error < StandardError; end;
       
-      VERSION = '0.1.3'
+      VERSION = '0.1.4'
 		
       attr_accessor :mc_file, :res_file, :dll_file
 		
@@ -97,7 +97,7 @@ if $0 == __FILE__
 		raise MC::Error, msg
 	end
 	
-	m = MC.new(mc_file)
+	m = MC.new(mc_file.chomp)
 	m.create_header
 	m.create_res_file
 	m.create_dll_file

data/test/{tc_eventlog.rb → test_eventlog.rb}

@@ -1,10 +1,12 @@
 ##############################################################################
-# tc_eventlog.rb
+# test_eventlog.rb
 #
 # Test case for the win32-eventlog package. You should run this test case
 # via the 'rake test' Rakefile task. This test will take a minute or two
 # to complete.
 #############################################################################
+require 'rubygems'
+gem 'test-unit'
 require 'test/unit'
 require 'win32/eventlog'
 require 'socket'
@@ -23,7 +25,7 @@ class TC_EventLog < Test::Unit::TestCase
    end
  
    def test_version
-      assert_equal('0.4.8', EventLog::VERSION)
+      assert_equal('0.5.0', EventLog::VERSION)
    end
    
    # Use the alias to validate it as well.

data/test/test_mc.rb

@@ -0,0 +1,67 @@
+############################################################################
+# test_mc.rb
+#
+# Test suite for the win32-mc library. The tests need to run in a specific
+# order, hence the numerics added to the method names.
+#
+# This test case should be run via the 'rake test' Rakefile task.
+############################################################################
+require 'rubygems'
+gem 'test-unit'
+require 'test/unit'
+require 'win32/mc'
+require 'ptools'
+include Win32
+
+class TC_Win32_MC < Test::Unit::TestCase
+   class << self
+      def startup
+         Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
+         @@mc_cmd = File.which('mc')
+         @@rc_cmd = File.which('rc')
+         @@link_cmd = File.which('link')
+      end
+      
+      def shutdown
+         @@mc_cmd = nil
+         @@rc_cmd = nil
+         @@link_cmd = nil
+      end      
+   end
+   
+   def setup 
+      @mc = MC.new('foo.mc')
+   end
+   
+   def test_01_version
+      assert_equal('0.1.4', MC::VERSION)
+   end
+
+   def test_02_create_header
+      omit_if(@@mc_cmd.nil?, "'mc' command not found - skipping")
+      assert_respond_to(@mc, :create_header)
+      assert_equal(true, @mc.create_header)
+   end
+
+   def test_03_create_res_file
+      omit_if(@@rc_cmd.nil?, "'rc' command not found - skipping")
+      assert_respond_to(@mc, :create_res_file)
+      assert_equal(true, @mc.create_res_file)
+   end
+   
+   def test_04_create_dll_file
+      omit_if(@@link_cmd.nil?, "'link' command not found - skipping")
+      assert_respond_to(@mc, :create_dll_file)
+      assert_equal(true, @mc.create_dll_file)
+   end
+   
+   def test_05_clean
+      assert_respond_to(@mc, :clean)
+      assert_nothing_raised{ @mc.clean }
+   end
+
+   def teardown
+      @mc = nil
+      File.delete('foo.dll') rescue nil
+   end
+end

data/win32-eventlog.gemspec

@@ -2,20 +2,23 @@ require "rubygems"
 
 spec = Gem::Specification.new do |gem|
    gem.name        = "win32-eventlog"
-   gem.version     = "0.4.9"
-   gem.author      = "Daniel J. Berger"
+   gem.version     = "0.5.0"
+   gem.authors     = ["Daniel J. Berger", "Park Heesob"]
    gem.email       = "djberg96@gmail.com"
    gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
    gem.platform    = Gem::Platform::RUBY
    gem.summary     = "Interface for the MS Windows Event Log."
    gem.description = "Interface for the MS Windows Event Log."
-   gem.test_file   = "test/ts_all.rb"
+   gem.test_files  = Dir["test/*.rb"]
    gem.has_rdoc    = true
+   gem.rubyforge_project = 'win32utils'
    gem.files       = Dir["lib/win32/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"]
    gem.files.reject! { |fn| fn.include? "CVS" }
    gem.require_path = "lib"
    gem.extra_rdoc_files = ["README", "CHANGES", "MANIFEST", "doc/tutorial.txt"]
-   gem.add_dependency("windows-pr", ">= 0.5.0")
+   gem.add_dependency("windows-pr", ">= 0.9.3")
+   gem.add_dependency("ptools", ">= 1.1.6")
+   gem.add_dependency("test-unit", ">= 2.0.0")
 end
 
 if $0 == __FILE__

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: win32-eventlog
 version: !ruby/object:Gem::Version 
-  version: 0.4.9
+  version: 0.5.0
 platform: ruby
 authors: 
 - Daniel J. Berger
+- Park Heesob
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-09-07 00:00:00 -06:00
+date: 2008-09-12 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +21,27 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.5.0
+        version: 0.9.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ptools
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
     version: 
 description: Interface for the MS Windows Event Log.
 email: djberg96@gmail.com
@@ -37,9 +58,8 @@ files:
 - lib/win32/eventlog.rb
 - lib/win32/mc.rb
 - test/foo.mc
-- test/tc_eventlog.rb
-- test/tc_mc.rb
-- test/ts_all.rb
+- test/test_eventlog.rb
+- test/test_mc.rb
 - CHANGES
 - doc
 - examples
@@ -49,6 +69,7 @@ files:
 - Rakefile
 - README
 - test
+- win32-eventlog-0.5.0.gem
 - win32-eventlog.gemspec
 - doc/tutorial.txt
 has_rdoc: true
@@ -72,10 +93,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: win32utils
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Interface for the MS Windows Event Log.
 test_files: 
-- test/ts_all.rb
+- test/test_eventlog.rb
+- test/test_mc.rb

data/test/tc_mc.rb

@@ -1,47 +0,0 @@
-############################################################################
-# tc_mc.rb
-#
-# Test suite for the win32-mc package.  The tests need to run in a specific
-# order, hence the numerics added to the method names.
-#
-# This test case should be run via the 'rake test' Rakefile task.
-############################################################################
-require 'test/unit'
-require 'win32/mc'
-include Win32
-
-class TC_Win32_MC < Test::Unit::TestCase
-   def setup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
-      @mc = MC.new('foo.mc')
-   end
-   
-   def test_01_version
-      assert_equal('0.1.3', MC::VERSION)
-   end
-
-   def test_02_create_header
-      assert_respond_to(@mc, :create_header)
-      assert_nothing_raised{ @mc.create_header }
-   end
-
-   def test_03_create_res_file
-      assert_respond_to(@mc, :create_res_file)
-      assert_nothing_raised{ @mc.create_res_file }
-   end
-   
-   def test_04_create_dll_file
-      assert_respond_to(@mc, :create_dll_file)
-      assert_nothing_raised{ @mc.create_dll_file }
-   end
-   
-   def test_05_clean
-      assert_respond_to(@mc, :clean)
-      assert_nothing_raised{ @mc.clean }
-   end
-
-   def teardown
-      @mc = nil
-      File.delete('foo.dll') rescue nil
-   end
-end

data/test/ts_all.rb

@@ -1,5 +0,0 @@
-$LOAD_PATH.unshift(Dir.pwd)
-$LOAD_PATH.unshift(File.join(Dir.pwd, 'test'))
-
-require 'tc_eventlog'
-require 'tc_mc'