win32-eventlog 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ceb5a13af0deadb88315e89d570a5f1aa2c79f27
-  data.tar.gz: 7b5687780d298adefe46bdd3c8f5216947cc3052
+  metadata.gz: 88fd3143cff77fa6e55e35cd8e3f33f4ec03b887
+  data.tar.gz: b9532c5facf8c98af6c3072f679b98dcc49f2856
 SHA512:
-  metadata.gz: c43100375b65b7b42eb8f571eb603dda0ecfcad79d4aa1936bd007feef87b7c8f7d03badddbb2e4dfb321919d1c9012d5abc5c34601d3a1f87d8be6a813e0c00
-  data.tar.gz: 34ad5d018e864eec47b0af9a936fa0248f35a2c0d0d0795c5e90bb1512817324dbcc3b7705390270376242d1315f457a495a2f7a0ab62c94eb0bf6a8cddd19a0
+  metadata.gz: c128e20a50648bc052ab926e32c06f46702a75f76040db23f4480a04450e17211927fa4054a99ac049e724951dcc45104df3847500d92ff96d0e692191201c0d
+  data.tar.gz: c513a361ef15f70f887433ff9cc6ebd32a630e2f71f96a752ff2bd77f06fb9a01f027b395048ef5c9816cbfb5dd6cbb3b48df96f0dfaf4231f9e882830fd4b06

data/CHANGES

@@ -1,3 +1,10 @@
+== 0.6.1 - 1-Jun-2014
+* Added the read_last_event instance method. This was already in the code as
+  as a private method but it is now public.
+* Removed some intermediate variables and properly re-use some memory pointers
+  to be more memory efficient.
+* Changed File.exists? to File.exist? everywhere to avoid warnings in Ruby 2.1.
+
 == 0.6.0 - 13-Jan-2014
 * Now assumes Windows Vista or later and Ruby 1.9.1 or later.
 * The code base has been converted to use FFI, and now works with JRuby.

data/README

@@ -59,11 +59,12 @@
   system.
 
 == Known Issues
-  JRuby users may need to increase their heap space.
+  * JRuby users may need to increase their heap space.
+  * JRuby x64 suffers from a bug that currently makes this library unusable.
+    See https://github.com/jruby/jruby/issues/1718.
 
   Please file any bug reports on the project page at
-  http://github.com/djberg96/win32-eventlog or
-  http://www.rubyforge.org/projects/win32utils.
+  http://github.com/djberg96/win32-eventlog.
 
 == License
   Artistic 2.0

data/examples/example_read.rb

@@ -17,10 +17,13 @@ sleep 1
 
 el = EventLog.new("Application")
 el.read{ |log|
-   p log
+  #p log.description if !log.description.empty?
+  p log
 }
+#p el.read_last_event
 el.close
 
+=begin
 EventLog.read("Application"){ |log|
    p log
    puts
@@ -81,4 +84,5 @@ e4.read{ |elr|
 puts "Finished reading backup file"
 e4.close
 
-File.delete(backup_file)
+File.delete(backup_file)
+=end

data/lib/win32/eventlog.rb

@@ -1,6 +1,6 @@
-require File.join(File.dirname(__FILE__), 'windows', 'constants')
-require File.join(File.dirname(__FILE__), 'windows', 'structs')
-require File.join(File.dirname(__FILE__), 'windows', 'functions')
+require_relative 'windows/constants'
+require_relative 'windows/structs'
+require_relative 'windows/functions'
 
 # The Win32 module serves as a namespace only.
 module Win32
@@ -18,7 +18,7 @@ module Win32
     class Error < StandardError; end
 
     # The version of the win32-eventlog library
-    VERSION = '0.6.0'
+    VERSION = '0.6.1'
 
     # The log is read in chronological order, i.e. oldest to newest.
     FORWARDS_READ = EVENTLOG_FORWARDS_READ
@@ -564,23 +564,16 @@ module Win32
           struct = EventLogStruct.new
           record = EVENTLOGRECORD.new(buf)
 
-          event_source = buf.read_bytes(buf.size)[56..-1][/^[^\0]*/]
-          computer = buf.read_bytes(buf.size)[56 + event_source.length + 1..-1][/^[^\0]*/]
-          user = get_user(record)
-
-          strings, desc = get_description(buf, event_source, lkey)
-
-          struct.source         = event_source
-          struct.computer       = computer
+          struct.source         = buf.read_bytes(buf.size)[56..-1][/^[^\0]*/]
+          struct.computer       = buf.read_bytes(buf.size)[56 + struct.source.length + 1..-1][/^[^\0]*/]
           struct.record_number  = record[:RecordNumber]
           struct.time_generated = Time.at(record[:TimeGenerated])
           struct.time_written   = Time.at(record[:TimeWritten])
           struct.event_id       = record[:EventID] & 0x0000FFFF
           struct.event_type     = get_event_type(record[:EventType])
-          struct.user           = user
+          struct.user           = get_user(record)
           struct.category       = record[:EventCategory]
-          struct.string_inserts = strings
-          struct.description 	  = desc
+          struct.string_inserts, struct.description = get_description(buf, struct.source, lkey)
 
           struct.freeze # This is read-only information
 
@@ -727,11 +720,9 @@ module Win32
 
     alias :write :report_event
 
-    private
-
-    # A private method that reads the last event log record.
+    # Reads the last event record.
     #
-    def read_last_event(handle=@handle, source=@source, server=@server)
+    def read_last_event
       buf    = FFI::MemoryPointer.new(:char, BUFFER_SIZE)
       read   = FFI::MemoryPointer.new(:ulong)
       needed = FFI::MemoryPointer.new(:ulong)
@@ -761,30 +752,25 @@ module Win32
 
       record = EVENTLOGRECORD.new(buf)
 
-      event_source  = buf.read_bytes(buf.size)[56..-1][/^[^\0]*/]
-      computer      = buf.read_bytes(buf.size)[56 + event_source.length + 1..-1][/^[^\0]*/]
-      event_type    = get_event_type(record[:EventType])
-      user          = get_user(record)
-      strings, desc = get_description(buf, event_source, lkey)
-
       struct = EventLogStruct.new
-      struct.source         = event_source
-      struct.computer       = computer
+      struct.source         = buf.read_bytes(buf.size)[56..-1][/^[^\0]*/]
+      struct.computer       = buf.read_bytes(buf.size)[56 + struct.source.length + 1..-1][/^[^\0]*/]
       struct.record_number  = record[:RecordNumber]
       struct.time_generated = Time.at(record[:TimeGenerated])
       struct.time_written   = Time.at(record[:TimeWritten])
       struct.event_id       = record[:EventID] & 0x0000FFFF
-      struct.event_type     = event_type
-      struct.user           = user
+      struct.event_type     = get_event_type(record[:EventType])
+      struct.user           = get_user(record)
       struct.category       = record[:EventCategory]
-      struct.string_inserts = strings
-      struct.description 	  = desc
+      struct.string_inserts, struct.description = get_description(buf, struct.source, lkey)
 
       struct.freeze # This is read-only information
 
       struct
     end
 
+    private
+
     # Private method that retrieves the user name based on data in the
     # EVENTLOGRECORD buffer.
     #
@@ -861,73 +847,75 @@ module Win32
           hkey  = hkey.read_pointer.to_i
           value = 'providerGuid'
 
-          guid  = FFI::MemoryPointer.new(:char, MAX_SIZE)
-          size  = FFI::MemoryPointer.new(:ulong)
+          guid_ptr = FFI::MemoryPointer.new(:char, MAX_SIZE)
+          size_ptr = FFI::MemoryPointer.new(:ulong)
 
-          size.write_ulong(guid.size)
+          size_ptr.write_ulong(guid_ptr.size)
 
-          if RegQueryValueEx(hkey, value, nil, nil, guid, size) == 0
-            guid  = guid.read_string
+          if RegQueryValueEx(hkey, value, nil, nil, guid_ptr, size_ptr) == 0
+            guid  = guid_ptr.read_string
             hkey2 = FFI::MemoryPointer.new(:uintptr_t)
             key   = "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\WINEVT\\Publishers\\#{guid}"
 
+            guid_ptr.free
+
             if RegOpenKeyEx(lkey, key, 0, KEY_READ|0x100, hkey2) == 0
               hkey2  = hkey2.read_pointer.to_i
 
               value = 'ParameterMessageFile'
-              file  = FFI::MemoryPointer.new(:char, MAX_SIZE)
-              size  = FFI::MemoryPointer.new(:ulong)
-
-              size.write_ulong(file.size)
+              file_ptr = FFI::MemoryPointer.new(:char, MAX_SIZE)
+              size_ptr.clear.write_ulong(file_ptr.size)
 
-              if RegQueryValueEx(hkey2, value, nil, nil, file, size) == 0
-                file = file.read_string
+              if RegQueryValueEx(hkey2, value, nil, nil, file_ptr, size_ptr) == 0
+                file = file_ptr.read_string
                 exe  = FFI::MemoryPointer.new(:char, MAX_SIZE)
                 ExpandEnvironmentStrings(file, exe, exe.size)
                 param_exe = exe.read_string
               end
 
               value = 'MessageFileName'
-              file  = FFI::MemoryPointer.new(:char, MAX_SIZE)
-              size  = FFI::MemoryPointer.new(:ulong)
 
-              size.write_ulong(file.size)
+              file_ptr.clear
+              size_ptr.clear.write_ulong(file_ptr.size)
 
-              if RegQueryValueEx(hkey2, value, nil, nil, file, size) == 0
-                file = file.read_string
+              if RegQueryValueEx(hkey2, value, nil, nil, file_ptr, size_ptr) == 0
+                file = file_ptr.read_string
                 exe  = FFI::MemoryPointer.new(:char, MAX_SIZE)
                 ExpandEnvironmentStrings(file, exe, exe.size)
                 message_exe = exe.read_string
               end
 
               RegCloseKey(hkey2)
+
+              file_ptr.free
+              size_ptr.free
             end
           else
             value = 'ParameterMessageFile'
-            file  = FFI::MemoryPointer.new(:char, MAX_SIZE)
-            size  = FFI::MemoryPointer.new(:ulong)
-
-            size.write_ulong(file.size)
+            file_ptr = FFI::MemoryPointer.new(:char, MAX_SIZE)
+            size_ptr.clear.write_ulong(file_ptr.size)
 
-            if RegQueryValueEx(hkey, value, nil, nil, file, size) == 0
-              file = file.read_string
+            if RegQueryValueEx(hkey, value, nil, nil, file_ptr, size_ptr) == 0
+              file = file_ptr.read_string
               exe  = FFI::MemoryPointer.new(:char, MAX_SIZE)
               ExpandEnvironmentStrings(file, exe, exe.size)
               param_exe = exe.read_string
             end
 
             value = 'EventMessageFile'
-            file  = FFI::MemoryPointer.new(:char, MAX_SIZE)
-            size  = FFI::MemoryPointer.new(:ulong)
 
-            size.write_ulong(file.size)
+            file_ptr.clear
+            size_ptr.clear.write_ulong(file_ptr.size)
 
-            if RegQueryValueEx(hkey, value, nil, nil, file, size) == 0
-              file = file.read_string
+            if RegQueryValueEx(hkey, value, nil, nil, file_ptr, size_ptr) == 0
+              file = file_ptr.read_string
               exe  = FFI::MemoryPointer.new(:char, MAX_SIZE)
               ExpandEnvironmentStrings(file, exe, exe.size)
               message_exe = exe.read_string
             end
+
+            file_ptr.free
+            size_ptr.free
           end
 
           RegCloseKey(hkey)
@@ -959,8 +947,8 @@ module Win32
               ExpandEnvironmentStrings(file, exe, exe.size)
               param_exe = exe.read_string
 
-              buf2 = FFI::MemoryPointer.new(:char, 8192)
-              val  = FFI::MemoryPointer.new(:ulong)
+              buf2.clear
+              val.clear
 
               bool = EvtGetPublisherMetadataProperty(
                 pubMetadata,
@@ -975,10 +963,15 @@ module Win32
                 raise SystemCallError.new('EvtGetPublisherMetadataProperty', FFI.errno)
               end
 
+              exe.clear
+
               file = buf2.read_string[16..-1]
-              exe  = FFI::MemoryPointer.new(:char, MAX_SIZE)
               ExpandEnvironmentStrings(file, exe, exe.size)
               message_exe = exe.read_string
+
+              buf2.free
+              val.free
+              exe.free
             end
           ensure
             EvtClose(pubMetadata) if pubMetadata
@@ -1034,7 +1027,7 @@ module Win32
         end
 
         if message_exe != nil
-          buf  = FFI::MemoryPointer.new(:char, 8192) # Reset the buffer
+          buf.clear
 
           # Try to retrieve message *without* expanding the inserts yet
           message_exe.split(';').each{ |lfile|

data/lib/win32/mc.rb

@@ -57,7 +57,7 @@ module Win32
     #
     def create_res_file
       rc_file = File.basename(@mc_file, '.mc') + '.rc'
-      unless File.exists?(rc_file)
+      unless File.exist?(rc_file)
         raise MC::Error, "No .rc file found: #{@rc_file}"
       end
       system("rc -r -fo #{@res_file} #{rc_file}")
@@ -68,7 +68,7 @@ module Win32
     # found.
     #
     def create_dll_file
-      unless File.exists?(@res_file)
+      unless File.exist?(@res_file)
         raise MC::Error, "No .res file found: #{@res_file}"
       end
       system("link -dll -noentry -out:#{@dll_file} #{@res_file}")
@@ -92,7 +92,7 @@ module Win32
 
       %w[.h .rc .res].each do |ext|
         file = base + ext
-        File.delete(file) if File.exists?(file)
+        File.delete(file) if File.exist?(file)
       end
 
       Dir["MSG*.bin"].each do |binfile|

data/test/test_eventlog.rb

@@ -25,7 +25,7 @@ class TC_Win32_EventLog < Test::Unit::TestCase
   end
 
   test "version constant is set to expected value" do
-    assert_equal('0.6.0', EventLog::VERSION)
+    assert_equal('0.6.1', EventLog::VERSION)
   end
 
   test "constructor basic functionality" do
@@ -77,7 +77,7 @@ class TC_Win32_EventLog < Test::Unit::TestCase
 
   test "backup works as expected" do
     assert_nothing_raised{ @log.backup(@bakfile) }
-    assert(File.exists?(@bakfile))
+    assert(File.exist?(@bakfile))
   end
 
   test "backup method fails if backup file already exists" do
@@ -167,6 +167,15 @@ class TC_Win32_EventLog < Test::Unit::TestCase
     assert_raises(ArgumentError){ @log.read(nil, 500, 'foo') }
   end
 
+  test "read_last_event method basic functionality" do
+    assert_respond_to(@log, :read_last_event)
+    assert_nothing_raised{ @log.read_last_event }
+  end
+
+  test "read_last_event returns the expected results" do
+    assert_kind_of(Win32::EventLog::EventLogStruct, @log.read_last_event)
+  end
+
   test "seek_read flag plus forwards_read flag works as expected" do
     flags = EventLog::SEEK_READ | EventLog::FORWARDS_READ
     assert_nothing_raised{ @last = @log.read[-10].record_number }
@@ -298,7 +307,7 @@ class TC_Win32_EventLog < Test::Unit::TestCase
 
   def teardown
     @log.close rescue nil
-    File.delete(@bakfile) if File.exists?(@bakfile)
+    File.delete(@bakfile) if File.exist?(@bakfile)
     @logfile  = nil
     @records  = nil
     @last     = nil

data/test/test_mc.rb

@@ -53,7 +53,7 @@ class TC_Win32_MC < Test::Unit::TestCase
 
   def teardown
     @mc = nil
-    File.delete('foo.dll') if File.exists?('foo.dll')
+    File.delete('foo.dll') if File.exist?('foo.dll')
   end
 
   def self.shutdown

data/win32-eventlog.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'win32-eventlog'
-  spec.version    = '0.6.0'
+  spec.version    = '0.6.1'
   spec.authors    = ['Daniel J. Berger', 'Park Heesob']
   spec.license    = 'Artistic 2.0'
   spec.email      = 'djberg96@gmail.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32-eventlog
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -9,62 +9,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2014-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ptools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
@@ -113,17 +113,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: win32utils
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Interface for the MS Windows Event Log.