win32-eventlog 0.4.2 → 0.4.3

data/CHANGES

@@ -1,3 +1,10 @@
+= 0.4.3 - 18-Dec-2006
+* Removed the FORMAT_MESSAGE_FROM_SYSTEM flag to the FormatMessage function
+  in the get_description private method because it could sometimes return
+  bogus information.  Thanks go to Greg Holmes for the spot.
+* Added the string_inserts member to the EventLogStruct.  This contains an
+  array of only the raw string inserts, rather than the entire text message.
+
 = 0.4.2 - 6-Aug-2006
 * Fixed a bug in the EventLog.read method related to the
   EVENTLOG_BACKWARDS_READ flag.

data/README

@@ -44,11 +44,8 @@ installed or they're not in your %PATH%.  If you have MSVC++, you should have
 them somewhere on your system.
 
 = Known Issues
-You may see this warning during the build and/or test phase:
-
-LINK : warning LNK4068: /MACHINE not specified; defaulting to X86
-
-You may ignore this warning.
+The code currently only checks the EventMessage file, it does not check the
+CategoryMessage or ParameterMessage files.
 
 = License
 Ruby's

data/install.rb

@@ -0,0 +1,13 @@
+# For those who don't like gems...
+require 'rbconfig'
+require 'ftools'
+include Config
+
+sitelibdir = CONFIG['sitelibdir']
+installdir = sitelibdir + '/win32'
+file1 = 'lib\win32\eventlog.rb'
+file2 = 'lib\win32\mc.rb'
+
+Dir.mkdir(installdir) unless File.exists?(installdir)
+File.copy(file1, installdir, true)
+File.copy(file2, installdir, true)

data/lib/win32/eventlog.rb

@@ -29,7 +29,7 @@ module Win32
       extend Windows::Error
       extend Windows::Registry
       
-      VERSION = '0.4.2'
+      VERSION = '0.4.3'
       
       # Aliased read flags
       FORWARDS_READ   = EVENTLOG_FORWARDS_READ
@@ -53,7 +53,7 @@ module Win32
       
       EventLogStruct = Struct.new('EventLogStruct', :record_number,
          :time_generated, :time_written, :event_id, :event_type, :category,
-         :source, :computer, :user, :description
+         :source, :computer, :user, :string_inserts, :description
       )
       
       # The name of the event log source.  This will typically be
@@ -430,6 +430,10 @@ module Win32
       # ignored.  If no flags are specified, then the default flags are:
       #   
       # EventLog::SEQUENTIAL_READ | EventLog::FORWARDS_READ
+      #
+      # Note that, if you're performing a SEEK_READ, then the offset must
+      # refer to a record number that actually exists.  The default of 0
+      # may or may not work for your particular event log.
       #   
       # The EventLogStruct struct contains the following members:
       #   
@@ -443,6 +447,7 @@ module Win32
       # computer       # String
       # user           # String or nil
       # description    # String or nil
+      # string_inserts # An array of Strings or nil
       #   
       # If no block is given the method returns an array of EventLogStruct's.
       # 
@@ -473,7 +478,7 @@ module Win32
                computer     = buf[56 + event_source.length + 1..-1].nstrip
                
                user = get_user(buf)
-               desc = get_description(buf, event_source)
+               strings, desc = get_description(buf, event_source)
       
                struct.source         = event_source
                struct.computer       = computer
@@ -484,6 +489,7 @@ module Win32
                struct.event_type     = get_event_type(buf[24,2].unpack('S').first)
                struct.user           = user
                struct.category       = buf[28,2].unpack('S').first
+               struct.string_inserts = strings
                struct.description 	 = desc
 
                if block_given?
@@ -646,15 +652,17 @@ module Win32
          struct
       end
       
-      # Private method that gets the event description (text) based on data
-      # from the EVENTLOGRECORD buffer.
+      # Private method that gets the string inserts (Array) and the full
+      # event description (String) based on data from the EVENTLOGRECORD
+      # buffer.
       # 
       def get_description(rec, event_source)    
-         str     = rec[ rec[36,4].unpack('L').first .. -1]         
+         str     = rec[rec[36,4].unpack('L').first .. -1]         
          num     = rec[26,2].unpack('S').first # NumStrings
          hkey    = [0].pack('L')
          key     = BASE_KEY + "#{@source}\\#{event_source}"
          buf     = 0.chr * 1024
+         va_list = nil
          
          if num == 0
             va_list_ptr = 0.chr * 4
@@ -684,7 +692,6 @@ module Win32
                   if hmodule != 0
                      FormatMessage(
                         FORMAT_MESSAGE_FROM_HMODULE |
-                        FORMAT_MESSAGE_FROM_SYSTEM |
                         FORMAT_MESSAGE_ARGUMENT_ARRAY,
                         hmodule,
                         event_id,
@@ -693,6 +700,7 @@ module Win32
                         buf.size,
                         va_list_ptr 
                      )
+                     
                      FreeLibrary(hmodule)
                   end
                }
@@ -700,7 +708,7 @@ module Win32
             
             RegCloseKey(hkey)
          end
-         buf.strip
+         [va_list, buf.strip]
       end
       
       # Private method that retrieves the user name based on data in the
@@ -751,4 +759,4 @@ module Win32
          end
       end
    end
-end
+end

data/win32-eventlog.gemspec

@@ -0,0 +1,24 @@
+require "rubygems"
+
+spec = Gem::Specification.new do |gem|
+   gem.name        = "win32-eventlog"
+   gem.version     = "0.4.3"
+   gem.author      = "Daniel J. Berger"
+   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.has_rdoc    = true
+   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", "doc/tutorial.txt"]
+   gem.add_dependency("windows-pr", ">= 0.5.0")
+end
+
+if $0 == __FILE__
+   Gem.manage_gems
+   Gem::Builder.new(spec).build
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: win32-eventlog
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
-date: 2006-08-06 00:00:00 -06:00
+  version: 0.4.3
+date: 2006-12-18 00:00:00 -07:00
 summary: Interface for the MS Windows Event Log.
 require_paths: 
 - lib
@@ -31,7 +31,6 @@ authors:
 files: 
 - lib/win32/eventlog.rb
 - lib/win32/mc.rb
-- lib/win32/test.rb
 - test/CVS
 - test/foo.mc
 - test/tc_eventlog.rb
@@ -39,8 +38,15 @@ files:
 - test/ts_all.rb
 - CHANGES
 - CVS
+- doc
+- examples
+- install.rb
+- lib
 - MANIFEST
+- misc
 - README
+- test
+- win32-eventlog.gemspec
 - doc/tutorial.txt
 test_files: 
 - test/ts_all.rb

data/lib/win32/test.rb

@@ -1,8 +0,0 @@
-$:.unshift Dir.pwd
-require 'eventlog'
-
-include Win32
-
-EventLog.open('System').tail{ |log|
-   p log
-}