win32-eventlog 0.4.8 → 0.4.9

data/CHANGES

@@ -1,3 +1,12 @@
+= 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
+  for this require a more recent windows-pr library, i.e. 0.9.2 or later.
+* Now properly separates the string inserts and description in the private
+  method get_last_event. This fixes the description and string_insert
+  properties for both the EventLog#tail and EventLog#notify_change methods.
+* Some internal refactoring to use begin/ensure where appropriate.
+
 = 0.4.8 - 17-May-2008
 * Fixed in a bug in the EventLog#read method where a log entry requiring
   over 64k would fail and spiral into an infinite loop. Thanks go to

data/README

@@ -50,7 +50,11 @@
    them somewhere on your system.
 
 = Known Issues
-   None known. Please file any bug reports on the project page at
+   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.
+
+   Please file any bug reports on the project page at
    http://www.rubyforge.org/projects/win32utils.
 
 = License

data/lib/win32/eventlog.rb

@@ -37,7 +37,8 @@ module Win32
       extend Windows::Error
       extend Windows::Registry
       
-      VERSION = '0.4.8'
+      # The version of the win32-eventlog library
+      VERSION = '0.4.9'
       
       # Aliased read flags
       FORWARDS_READ   = EVENTLOG_FORWARDS_READ
@@ -170,8 +171,15 @@ module Win32
       def self.add_event_source(args)
          raise TypeError unless args.is_a?(Hash)
          
-         valid_keys = %w/source key_name category_count event_message_file
-            category_message_file parameter_message_file supported_types/
+         valid_keys = %w/
+            source
+            key_name
+            category_count
+            event_message_file
+            category_message_file
+            parameter_message_file
+            supported_types
+         /
 
          key_base = "SYSTEM\\CurrentControlSet\\Services\\EventLog\\"
 
@@ -220,140 +228,139 @@ module Win32
          hkey = hkey.unpack('L')[0]        
          data = "%SystemRoot%\\System32\\config\\#{hash['source']}.evt"
          
-         rv = RegSetValueEx(
-            hkey,
-            'File',
-            0,
-            REG_EXPAND_SZ,
-            data,
-            data.size
-         )
-                     
-         if rv != ERROR_SUCCESS
-            error = 'RegSetValueEx() failed: ', get_last_error
-            RegCloseKey(hkey)
-            raise Error, error
-         end
-         
-         RegCloseKey(hkey)         
-         
-         hkey = [0].pack('L')
-         key  = key_base << hash['source'] << "\\" << hash['key_name']
-         
-         disposition = [0].pack('L')
-         
-         rv = RegCreateKeyEx(
-         	HKEY_LOCAL_MACHINE,
-            key,
-            0,
-            nil,
-            REG_OPTION_NON_VOLATILE,
-            KEY_WRITE,
-            nil,
-            hkey,
-            disposition
-          )
-        
-          if rv != ERROR_SUCCESS
-             raise Error, 'RegCreateKeyEx() failed: ' + get_last_error
-          end
-         
-         hkey = hkey.unpack('L')[0]
-         
-         if hash['category_count']
-            data = [hash['category_count']].pack('L')
-            
+         begin
             rv = RegSetValueEx(
                hkey,
-               'CategoryCount',
+               'File',
                0,
-               REG_DWORD,
+               REG_EXPAND_SZ,
                data,
                data.size
             )
-            
+                        
             if rv != ERROR_SUCCESS
-               error = 'RegSetValueEx() failed: ' + get_last_error
-               RegCloseKey(hkey)
+               error = 'RegSetValueEx() failed: ', get_last_error
                raise Error, error
             end
+         ensure
+            RegCloseKey(hkey)         
          end
          
-         if hash['category_message_file']
-            data = File.expand_path(hash['category_message_file'])
-            
-            rv = RegSetValueEx(
-               hkey,
-               'CategoryMessageFile',
+         hkey = [0].pack('L')
+         key  = key_base << hash['source'] << "\\" << hash['key_name']
+         
+         disposition = [0].pack('L')
+         
+         begin
+            rv = RegCreateKeyEx(
+               HKEY_LOCAL_MACHINE,
+               key,
                0,
-               REG_EXPAND_SZ,
-               data,
-               data.size
+               nil,
+               REG_OPTION_NON_VOLATILE,
+               KEY_WRITE,
+               nil,
+               hkey,
+               disposition
             )
-            
+           
             if rv != ERROR_SUCCESS
-               error = 'RegSetValueEx() failed: ' + get_last_error
-               RegCloseKey(hkey)
-               raise Error, error
+               raise Error, 'RegCreateKeyEx() failed: ' + get_last_error
             end
-         end
-         
-         if hash['event_message_file']
-            data = File.expand_path(hash['event_message_file'])
             
-            rv = RegSetValueEx(
-               hkey,
-               'EventMessageFile',
-               0,
-               REG_EXPAND_SZ,
-               data,
-               data.size
-            )
+            hkey = hkey.unpack('L')[0]
             
-            if rv != ERROR_SUCCESS
-               error = 'RegSetValueEx() failed: ' + get_last_error
-               RegCloseKey(hkey)
-               raise Error, error
+            if hash['category_count']
+               data = [hash['category_count']].pack('L')
+               
+               rv = RegSetValueEx(
+                  hkey,
+                  'CategoryCount',
+                  0,
+                  REG_DWORD,
+                  data,
+                  data.size
+               )
+               
+               if rv != ERROR_SUCCESS
+                  error = 'RegSetValueEx() failed: ' + get_last_error
+                  raise Error, error
+               end
             end
-         end
-         
-         if hash['parameter_message_file']
-            data = File.expand_path(hash['parameter_message_file'])
-                                
+            
+            if hash['category_message_file']
+               data = File.expand_path(hash['category_message_file'])
+               
+               rv = RegSetValueEx(
+                  hkey,
+                  'CategoryMessageFile',
+                  0,
+                  REG_EXPAND_SZ,
+                  data,
+                  data.size
+               )
+               
+               if rv != ERROR_SUCCESS
+                  error = 'RegSetValueEx() failed: ' + get_last_error
+                  raise Error, error
+               end
+            end
+            
+            if hash['event_message_file']
+               data = File.expand_path(hash['event_message_file'])
+               
+               rv = RegSetValueEx(
+                  hkey,
+                  'EventMessageFile',
+                  0,
+                  REG_EXPAND_SZ,
+                  data,
+                  data.size
+               )
+               
+               if rv != ERROR_SUCCESS
+                  error = 'RegSetValueEx() failed: ' + get_last_error
+                  raise Error, error
+               end
+            end
+            
+            if hash['parameter_message_file']
+               data = File.expand_path(hash['parameter_message_file'])
+                                   
+               rv = RegSetValueEx(
+                  hkey,
+                  'ParameterMessageFile',
+                  0,
+                  REG_EXPAND_SZ,
+                  data,
+                  data.size
+               )
+                        
+               if rv != ERROR_SUCCESS
+                  error = 'RegSetValueEx() failed: ' + get_last_error
+                  raise Error, error
+               end
+            end         
+            
+            data = [hash['supported_types']].pack('L')
+
             rv = RegSetValueEx(
                hkey,
-               'ParameterMessageFile',
+               'TypesSupported',
                0,
-               REG_EXPAND_SZ,
+               REG_DWORD,
                data,
                data.size
             )
-                     
+               
             if rv != ERROR_SUCCESS
                error = 'RegSetValueEx() failed: ' + get_last_error
-               RegCloseKey(hkey)
                raise Error, error
             end
-         end         
-         
-         data = [hash['supported_types']].pack('L')
-         rv = RegSetValueEx(
-            hkey,
-            'TypesSupported',
-            0,
-            REG_DWORD,
-            data,
-            data.size
-         )
-            
-         if rv != ERROR_SUCCESS
-            error = 'RegSetValueEx() failed: ' + get_last_error
+         ensure
             RegCloseKey(hkey)
-            raise Error, error
          end
          
-         RegCloseKey(hkey)
-         
          disposition.unpack('L')[0]
       end
       
@@ -462,16 +469,18 @@ module Win32
          
          wait_result = WaitForSingleObject(event, INFINITE)
          
-         if wait_result == WAIT_FAILED
-            error = 'WaitForSingleObject() failed: ' + get_last_error
+         begin
+            if wait_result == WAIT_FAILED
+               error = 'WaitForSingleObject() failed: ' + get_last_error
+               raise Error, error
+            else
+               last = read_last_event
+               block.call(last)
+            end
+         ensure
             CloseHandle(event)
-            raise Error, error
-         else
-            last = read_last_event
-            block.call(last)
          end
    
-         CloseHandle(event)
          self
       end
       
@@ -743,11 +752,11 @@ module Win32
             lkey = hkey.unpack('L').first
          end
       
-         event_source = buf[56..-1].nstrip
-         computer     = buf[56 + event_source.length + 1..-1].nstrip
-         event_type   = get_event_type(buf[24,2].unpack('S')[0])
-         user         = get_user(buf)
-         desc         = get_description(buf, event_source, lkey)
+         event_source  = buf[56..-1].nstrip
+         computer      = buf[56 + event_source.length + 1..-1].nstrip
+         event_type    = get_event_type(buf[24,2].unpack('S')[0])
+         user          = get_user(buf)
+         strings, desc = get_description(buf, event_source, lkey)
       
          struct = EventLogStruct.new
          struct.source         = event_source
@@ -759,6 +768,7 @@ module Win32
          struct.event_type     = event_type
          struct.user           = user
          struct.category       = buf[28,2].unpack('S')[0]
+         struct.string_inserts = strings
          struct.description 	 = desc
          
          struct
@@ -823,123 +833,146 @@ module Win32
          key     = BASE_KEY + "#{@source}\\#{event_source}"
          buf     = 0.chr * 8192
          va_list = va_list0 = (num == 0) ? [] : str.unpack('Z*' * num)
+
+         begin
+            if defined? Wow64DisableWow64FsRedirection
+               old_wow_val = 0.chr * 4
+               Wow64DisableWow64FsRedirection(old_wow_val)
+            end
       
-         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               
-               ExpandEnvironmentStrings(file, exe, exe.size)
-               exe = exe.nstrip
-               
-               va_list = va_list0.map{ |v|
-                  va = v
-               
-                  v.scan(/%%(\d+)/).uniq.each{ |x|
-                     exe.split(';').each{ |file|             
-                        hmodule  = LoadLibraryEx(
-                           file,
-                           0,
-                           DONT_RESOLVE_DLL_REFERENCES
-                        )
-                        
-                        if hmodule != 0
-                           FormatMessage(
-                              FORMAT_MESSAGE_FROM_HMODULE |
-                              FORMAT_MESSAGE_ARGUMENT_ARRAY,
-                              hmodule,
-                              x.first.to_i,
+            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               
+                  ExpandEnvironmentStrings(file, exe, exe.size)
+                  exe = exe.nstrip
+                  
+                  va_list = va_list0.map{ |v|
+                     va = v
+                  
+                     v.scan(/%%(\d+)/).uniq.each{ |x|
+                        exe.split(';').each{ |file|             
+                           hmodule  = LoadLibraryEx(
+                              file,
                               0,
-                              buf,
-                              buf.size,
-                              v
+                              DONT_RESOLVE_DLL_REFERENCES |
+                              LOAD_LIBRARY_AS_DATAFILE
                            )
-                           FreeLibrary(hmodule)
-                           break if buf.nstrip != ""
-                        end
+                           
+                           if hmodule != 0
+                              FormatMessage(
+                                 FORMAT_MESSAGE_FROM_HMODULE |
+                                 FORMAT_MESSAGE_ARGUMENT_ARRAY,
+                                 hmodule,
+                                 x.first.to_i,
+                                 0,
+                                 buf,
+                                 buf.size,
+                                 v
+                              )
+                              FreeLibrary(hmodule)
+                              break if buf.nstrip != ""
+                           end
+                        }
+                        va = va.gsub("%%#{x.first}", buf.nstrip)     
                      }
-                     va = va.gsub("%%#{x.first}", buf.nstrip)     
+                     va
                   }
-                  va
-               }
-            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
+               end
+             
+               value = 'EventMessageFile'
+               file  = 0.chr * MAX_SIZE
+               size  = [file.length].pack('L')
                     
-               ExpandEnvironmentStrings(file, exe, exe.size)
-               exe = exe.nstrip
-       
-               # Try to retrieve message *without* expanding the inserts yet
-               exe.split(';').each{ |file|
-                  hmodule  = LoadLibraryEx(file, 0, DONT_RESOLVE_DLL_REFERENCES)
-                  event_id = rec[20,4].unpack('L')[0]
-                  
-                  if hmodule != 0
-                     FormatMessage(
-                        FORMAT_MESSAGE_FROM_HMODULE |
-                        FORMAT_MESSAGE_IGNORE_INSERTS,
-                        hmodule,
-                        event_id,
+               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,
                         0,
-                        buf,
-                        buf.size,
-                        nil
+                        DONT_RESOLVE_DLL_REFERENCES | LOAD_LIBRARY_AS_DATAFILE
                      )
-                          
-                     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*')
-               end
-      
-               exe.split(';').each{ |file|
-                  hmodule  = LoadLibraryEx(file, 0, DONT_RESOLVE_DLL_REFERENCES)
-                  event_id = rec[20,4].unpack('L')[0]
+
+                     event_id = rec[20,4].unpack('L')[0]
+                     
+                     if hmodule != 0
+                        FormatMessage(
+                           FORMAT_MESSAGE_FROM_HMODULE |
+                           FORMAT_MESSAGE_IGNORE_INSERTS,
+                           hmodule,
+                           event_id,
+                           0,
+                           buf,
+                           buf.size,
+                           nil
+                        )
+                             
+                        FreeLibrary(hmodule)
+                        break if buf.nstrip != "" # All messages read
+                     end
+                  }
+                  
+                  buf  = 0.chr * 8192 # Reset the buffer
                
-                  if hmodule != 0
-                     FormatMessage(
-                        FORMAT_MESSAGE_FROM_HMODULE |
-                        FORMAT_MESSAGE_ARGUMENT_ARRAY,
-                        hmodule,
-                        event_id,
+                  # 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
+         
+                  exe.split(';').each{ |file|
+                     hmodule = LoadLibraryEx(
+                        file,
                         0,
-                        buf,
-                        buf.size,
-                        va_list_ptr
+                        DONT_RESOLVE_DLL_REFERENCES | LOAD_LIBRARY_AS_DATAFILE
                      )
-                          
-                     FreeLibrary(hmodule)
-                     break if buf.nstrip != "" # All messages read
-                  end
-               }
+
+                     event_id = rec[20,4].unpack('L')[0]
+                  
+                     if hmodule != 0
+                        FormatMessage(
+                           FORMAT_MESSAGE_FROM_HMODULE |
+                           FORMAT_MESSAGE_ARGUMENT_ARRAY,
+                           hmodule,
+                           event_id,
+                           0,
+                           buf,
+                           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])
             end
-            RegCloseKey(hkey)
          end
+
          [va_list0, buf.strip]
       end      
    end

data/win32-eventlog.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |gem|
    gem.name        = "win32-eventlog"
-   gem.version     = "0.4.8"
+   gem.version     = "0.4.9"
    gem.author      = "Daniel J. Berger"
    gem.email       = "djberg96@gmail.com"
    gem.homepage    = "http://www.rubyforge.org/projects/win32utils"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win32-eventlog
 version: !ruby/object:Gem::Version 
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-17 00:00:00 -06:00
+date: 2008-09-07 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: windows-pr
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -35,13 +36,11 @@ extra_rdoc_files:
 files: 
 - lib/win32/eventlog.rb
 - lib/win32/mc.rb
-- test/CVS
 - test/foo.mc
 - test/tc_eventlog.rb
 - test/tc_mc.rb
 - test/ts_all.rb
 - CHANGES
-- CVS
 - doc
 - examples
 - lib
@@ -74,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Interface for the MS Windows Event Log.