winevt_c 0.8.0 → 0.9.3

data/README.md

@@ -1,42 +1,97 @@
-# winevt_c
-
-[![Build status](https://ci.appveyor.com/api/projects/status/o5771b3cb6x3acq0/branch/master?svg=true)](https://ci.appveyor.com/project/cosmo0920/winevt-c-6145k/branch/master)
-
-## Prerequisites
-
-* Windows Vista/Windows Server 2008 or later.
-* gcc and g++ from MSYS2 for building C/C++ extension.
-* Ruby 2.4 or later with MSYS2.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'winevt_c'
-```
-
-And then execute:
-
-    $ ridk exec bundle
-
-Or install it yourself as:
-
-    $ ridk exec gem install winevt_c
-
-## Fat gems building
-
-* Docker is needed to build fat gem due to rake-compiler-dock uses docker container.
-
-## Usage
-
-Usage examples are found in [example directory](example).
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/fluent-plugins-nursery/winevt_c.
+# winevt_c
+
+[![Build status](https://ci.appveyor.com/api/projects/status/o5771b3cb6x3acq0/branch/master?svg=true)](https://ci.appveyor.com/project/cosmo0920/winevt-c-6145k/branch/master)
+
+## Prerequisites
+
+* Windows Vista/Windows Server 2008 or later.
+* gcc and g++ from MSYS2 for building C/C++ extension.
+* Ruby 2.4 or later with MSYS2.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'winevt_c'
+```
+
+And then execute:
+
+    $ ridk exec bundle
+
+Or install it yourself as:
+
+    $ ridk exec gem install winevt_c
+
+## Fat gems building
+
+* Docker is needed to build fat gem due to rake-compiler-dock uses docker container.
+
+## Usage
+
+Usage examples are found in [example directory](example).
+
+### Multilingual description
+
+Currently, the following locales should be supported to output description:
+
+locale    | language
+---------:|:--------
+bg\_BG    | Bulgarian
+zh\_CN    | Simplified Chinese
+zh\_TW    | Traditional Chinese
+zh\_HK    | Chinese (Hong Kong)
+zh\_SG    | Chinese (Singapore)
+hr\_HR    | Croatian
+cz\_CZ    | Czech
+da\_DK    | Danish
+nl\_NL    | Dutch
+nl\_BG    | Dutch (Belgium)
+en\_US    | English (United States)
+en\_GB    | English (UK)
+en\_AU    | English (Australia)
+en\_CA    | English (Canada)
+en\_NZ    | English (New Zealand)
+en\_IE    | English (Ireland)
+fi\_FI    | Finnish
+fr\_FR    | French
+fr\_BE    | French (Belgium)
+fr\_CA    | French (Canada)
+fr\_CH    | French (Swiss)
+de\_DE    | German
+de\_CH    | German (Swiss)
+de\_AT    | German (Austria)
+el\_GR    | Greek (Ελληνικά)
+hu\_HU    | Hungarian
+is\_IS    | Icelandic
+it\_IT    | Italian (Italy)
+it\_CH    | Italian (Swiss)
+ja\_JP    | Japanese
+ko\_KO    | Korean
+no\_NO    | Norwegian (Bokmål)
+nb\_NO    | Norwegian (Bokmål)
+nn\_NO    | Norwegian (Nynorsk)
+pl\_PL    | Polish (Poland)
+pt\_PT    | Portuguese
+pt\_BR    | Portuguese (Brazil)
+ro\_RO    | Romanian
+ru\_RU    | Russian (русский язык)
+sk\_SK    | Slovak
+sl\_SI    | Slovenian
+es\_ES    | Spanish
+es\_ES\_T | Spanish (Traditional)
+es\_MX    | Spanish (Mexico)
+es\_ES\_M | Spanish (Modern)
+sv\_SE    | Swedish
+tr\_TR    | Turkish
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fluent-plugins-nursery/winevt_c.

data/Rakefile

@@ -1,37 +1,37 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require "rake/testtask"
-require 'rake_compiler_dock'
-require 'rake/clean'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-require "rake/extensiontask"
-
-spec = eval File.read("winevt_c.gemspec")
-
-Rake::ExtensionTask.new("winevt", spec) do |ext|
-  ext.ext_dir = 'ext/winevt'
-  ext.cross_compile = true
-  ext.lib_dir = File.join(*['lib', 'winevt', ENV['FAT_DIR']].compact)
-  # cross_platform names are of MRI's platform name
-  ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
-end
-
-desc 'Build gems for Windows per rake-compiler-dock'
-task 'gem:native' do
-  # See RUBY_CC_VERSION in https://github.com/rake-compiler/rake-compiler-dock/blob/master/Dockerfile.mri
-  RakeCompilerDock.sh <<-EOS
-    gem install bundler yard --no-doc && bundle
-    rake cross native gem RUBY_CC_VERSION=2.4.0:2.5.0:2.6.0:2.7.0
-EOS
-end
-
-CLEAN.include('lib/winevt/winevt.*')
-
-task :default => [:clobber, :compile, :test]
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+require 'rake_compiler_dock'
+require 'rake/clean'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rake/extensiontask"
+
+spec = eval File.read("winevt_c.gemspec")
+
+Rake::ExtensionTask.new("winevt", spec) do |ext|
+  ext.ext_dir = 'ext/winevt'
+  ext.cross_compile = true
+  ext.lib_dir = File.join(*['lib', 'winevt', ENV['FAT_DIR']].compact)
+  # cross_platform names are of MRI's platform name
+  ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
+end
+
+desc 'Build gems for Windows per rake-compiler-dock'
+task 'gem:native' do
+  sh "bundle package"
+  # See RUBY_CC_VERSION in https://github.com/rake-compiler/rake-compiler-dock/blob/master/Dockerfile.mri
+  %w[ x86-mingw32 x64-mingw32 ].each do |plat|
+    RakeCompilerDock.sh "bundle --local && bundle exec rake native:#{plat} gem RUBY_CC_VERSION=2.4.0:2.5.0:2.6.0:2.7.0:3.0.0", platform: plat
+  end
+end
+
+CLEAN.include('lib/winevt/winevt.*')
+
+task :default => [:clobber, :compile, :test]

data/appveyor.yml

@@ -1,26 +1,32 @@
-version: '{build}'
-
-# init:
-#   - ps: iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
-
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - ruby --version
-  - gem --version
-  - bundle --version
-  - bundle install
-  - ridk.cmd exec bundle exec rake compile
-build: off
-test_script:
-  # - bundle exec rake test
-  - bundle exec rake test TESTOPTS=-v
-
-# https://www.appveyor.com/docs/installed-software/#ruby
-environment:
-  matrix:
-    - ruby_version: "26-x64"
-    - ruby_version: "26"
-    - ruby_version: "25-x64"
-    - ruby_version: "25"
-    - ruby_version: "24-x64"
-    - ruby_version: "24"
+version: '{build}'
+
+image: Visual Studio 2019
+
+# init:
+#   - ps: iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - ruby --version
+  - gem --version
+  - bundle --version
+  - bundle install
+  - ridk.cmd exec bundle exec rake compile
+build: off
+test_script:
+  # - bundle exec rake test
+  - bundle exec rake test TESTOPTS=-v
+
+# https://www.appveyor.com/docs/installed-software/#ruby
+environment:
+  matrix:
+    - ruby_version: "30-x64"
+    - ruby_version: "30"
+    - ruby_version: "27-x64"
+    - ruby_version: "27"
+    - ruby_version: "26-x64"
+    - ruby_version: "26"
+    - ruby_version: "25-x64"
+    - ruby_version: "25"
+    - ruby_version: "24-x64"
+    - ruby_version: "24"

data/example/bookmark.rb

@@ -1,9 +1,9 @@
-require 'winevt'
-
-@query = Winevt::EventLog::Query.new("Application", "*[System[(Level <= 3) and TimeCreated[timediff(@SystemTime) <= 86400000]]]")
-@bookmark = Winevt::EventLog::Bookmark.new
-@query.each do |xml|
-  @bookmark.update(@query)
-end
-
-puts @bookmark.render
+require 'winevt'
+
+@query = Winevt::EventLog::Query.new("Application", "*[System[(Level <= 3) and TimeCreated[timediff(@SystemTime) <= 86400000]]]")
+@bookmark = Winevt::EventLog::Bookmark.new
+@query.each do |xml|
+  @bookmark.update(@query)
+end
+
+puts @bookmark.render

data/example/enumerate_channels.rb

@@ -1,13 +1,13 @@
-require 'winevt'
-
-@channels = Winevt::EventLog::Channel.new
-@channels.force_enumerate = false
-result = []
-@channels.each do |channel|
-  result << channel
-end
-
-puts "length of channels: #{result.length}"
-result.each do |r|
-  puts r
-end
+require 'winevt'
+
+@channels = Winevt::EventLog::Channel.new
+@channels.force_enumerate = false
+result = []
+@channels.each do |channel|
+  result << channel
+end
+
+puts "length of channels: #{result.length}"
+result.each do |r|
+  puts r
+end

data/example/eventlog.rb

@@ -1,9 +1,13 @@
-require 'winevt'
-
-@query = Winevt::EventLog::Query.new("Application", "*[System[(Level <= 3) and TimeCreated[timediff(@SystemTime) <= 86400000]]]")
-
-@query.render_as_xml = true
-@query.preserve_qualifiers = true
-@query.each do |eventlog, message, string_inserts|
-  puts ({eventlog: eventlog, data: message})
-end
+require 'winevt'
+
+@session = Winevt::EventLog::Session.new("127.0.0.1") # Or remote box ip
+# @session.domain = "<EXAMPLEGROUP>"
+# @session.username = "<username>"
+# @session.password = "<password>"
+@query = Winevt::EventLog::Query.new("Application", "*[System[(Level <= 4) and TimeCreated[timediff(@SystemTime) <= 86400000]]]", @session)
+
+@query.render_as_xml = true
+@query.preserve_qualifiers = true
+@query.each do |eventlog, message, string_inserts|
+  puts ({eventlog: eventlog, data: message})
+end

data/example/locale.rb

@@ -0,0 +1,13 @@
+require 'winevt'
+
+@locale = Winevt::EventLog::Locale.new
+
+header = <<EOC
+locale    | language
+---------:|:--------
+EOC
+
+print header
+@locale.each do |code, desc|
+  print "#{code.gsub("_", "\\_")}#{" "*(8 - code.size)}| #{desc}\n"
+end

data/example/rate_limit.rb

@@ -1,14 +1,14 @@
-require 'winevt'
-
-@subscribe = Winevt::EventLog::Subscribe.new
-@subscribe.read_existing_events = true
-@subscribe.rate_limit = 80
-@subscribe.subscribe(
-  "Application", "*[System[(Level <= 4) and TimeCreated[timediff(@SystemTime) <= 86400000]]]"
-)
-while true do
-  @subscribe.each do |eventlog, message, string_inserts|
-    puts ({eventlog: eventlog, data: message})
-  end
-  sleep(0.1)
-end
+require 'winevt'
+
+@subscribe = Winevt::EventLog::Subscribe.new
+@subscribe.read_existing_events = true
+@subscribe.rate_limit = 80
+@subscribe.subscribe(
+  "Application", "*[System[(Level <= 4) and TimeCreated[timediff(@SystemTime) <= 86400000]]]"
+)
+while true do
+  @subscribe.each do |eventlog, message, string_inserts|
+    puts ({eventlog: eventlog, data: message})
+  end
+  sleep(0.1)
+end

data/example/tailing.rb

@@ -1,15 +1,21 @@
-require 'winevt'
-
-@subscribe = Winevt::EventLog::Subscribe.new
-@subscribe.read_existing_events = true
-@subscribe.preserve_qualifiers = true
-@subscribe.render_as_xml = true
-@subscribe.subscribe(
-  "Security", "*[System[(Level <= 4) and TimeCreated[timediff(@SystemTime) <= 86400000]]]"
-)
-while true do
-  @subscribe.each do |eventlog, message, string_inserts|
-    puts ({eventlog: eventlog, data: message})
-  end
-  sleep(1)
-end
+require 'winevt'
+
+@session = Winevt::EventLog::Session.new("127.0.0.1") # Or remote box ip
+# @session.domain = "<EXAMPLEGROUP>"
+# @session.username = "<username>"
+# @session.password = "<password>"
+@bookmark = Winevt::EventLog::Bookmark.new
+@subscribe = Winevt::EventLog::Subscribe.new
+@subscribe.read_existing_events = true
+@subscribe.preserve_qualifiers = true
+@subscribe.render_as_xml = true
+@subscribe.subscribe(
+  "Security", "*[System[(Level <= 4) and TimeCreated[timediff(@SystemTime) <= 86400000]]]",
+  @bookmark, @session
+)
+while true do
+  @subscribe.each do |eventlog, message, string_inserts|
+    puts ({eventlog: eventlog, data: message})
+  end
+  sleep(1)
+end

data/ext/winevt/extconf.rb

@@ -1,24 +1,24 @@
-require "mkmf"
-require "rbconfig"
-
-if RbConfig::CONFIG['host_os'] =~ /mingw/
-  $CFLAGS << ' -fno-omit-frame-pointer'
-end
-
-libdir = RbConfig::CONFIG["libdir"]
-includedir = RbConfig::CONFIG["includedir"]
-
-dir_config("winevt", includedir, libdir)
-
-have_library("wevtapi")
-have_func("EvtQuery", "winevt.h")
-have_library("advapi32")
-have_library("ole32")
-
-$LDFLAGS << " -lwevtapi -ladvapi32 -lole32"
-$CFLAGS << " -Wall -std=c99 -fPIC -fms-extensions "
-$CXXFLAGS << " -Wall -std=c++11 -fPIC -fms-extensions "
-# $CFLAGS << " -g -O0 -ggdb"
-# $CXXFLAGS << " -g -O0 -ggdb"
-
-create_makefile("winevt/winevt")
+require "mkmf"
+require "rbconfig"
+
+if RbConfig::CONFIG['host_os'] =~ /mingw/
+  $CFLAGS << ' -fno-omit-frame-pointer'
+end
+
+libdir = RbConfig::CONFIG["libdir"]
+includedir = RbConfig::CONFIG["includedir"]
+
+dir_config("winevt", includedir, libdir)
+
+have_library("wevtapi")
+have_func("EvtQuery", "winevt.h")
+have_library("advapi32")
+have_library("ole32")
+
+$LDFLAGS << " -lwevtapi -ladvapi32 -lole32"
+$CFLAGS << " -Wall -std=c99 -fPIC -fms-extensions "
+$CXXFLAGS << " -Wall -std=c++11 -fPIC -fms-extensions "
+# $CFLAGS << " -g -O0 -ggdb"
+# $CXXFLAGS << " -g -O0 -ggdb"
+
+create_makefile("winevt/winevt")