winevt_c 0.4.7.rc2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 549d42791fee93a96721851c2d4311affcac0518c27b3f813232909c2f714ef3
-  data.tar.gz: 15ef2c5d0abf1edcd6b87affc2c8660787d6fe67c4289cf76e8743bb3f13688e
+  metadata.gz: 2c5fe0d33a16157b78dd2d2dba8f35aab97d17fd4a331dcbcca982dd1b19bf6c
+  data.tar.gz: 9a54b57a79cce2295c03b640d66f09bca1f862b8514e9eebd4e0ec424ad1a134
 SHA512:
-  metadata.gz: 89ff8942faaf4463d92319ff68215042b5582ec3fca8488f1fbc995f7a8be91270c801cf7ddd7b02cf3bcb3b2e1f02300af26ccfadbe5c2476ca104f4f28e8f5
-  data.tar.gz: 8b6f7abca4e7d1f80e82a86133e38bcbf967e53dd14f06ee02966b8d612e6eab35e4adab06ccb0e925e0512254b8211c761a67ddd0d30a5f39aa6ed539339e24
+  metadata.gz: 0cdf4bcb81c5cd0cbd3c26a552e9310cb14cc528daa22d0216ad9af86e65978f9757267677b7a399754cc1f6e490df84616fb1af943ad8494239efc25a4c5bcb
+  data.tar.gz: f10753a472d9306ec0ac217e5186787382d33921809a7d48cc3cf0a99abe7dacab2c1b784a2bcc6444fc42a51f7d8c6c51fc81648e2adb71e5ac6cd3059e0999

data/example/tailing.rb

@@ -13,6 +13,7 @@ while (1) do
     message = sprintf(message, *string_inserts)
 
     puts ({eventlog: eventlog, data: message})
+    @subscribe.close_handle # Dispose EVT_HANDLE variable which is allocated in EvtNext
   else
     printf(".")
     sleep(1)

data/ext/winevt/winevt_channel.c

@@ -71,16 +71,20 @@ rb_winevt_channel_each(VALUE self)
         break;
       } else if (ERROR_INSUFFICIENT_BUFFER == status) {
         bufferSize = bufferUsed;
-        temp = (LPWSTR)xrealloc(buffer, bufferSize * sizeof(WCHAR));
+        temp = (LPWSTR)malloc(bufferSize * sizeof(WCHAR));
         if (temp) {
           buffer = temp;
           temp = NULL;
-          EvtNextChannelPath(winevtChannel->channels, bufferSize, buffer, &bufferUsed);
+          continue;
         } else {
+          free(buffer);
+          EvtClose(winevtChannel->channels);
           status = ERROR_OUTOFMEMORY;
           rb_raise(rb_eRuntimeError, "realloc failed");
         }
       } else {
+        free(buffer);
+        EvtClose(winevtChannel->channels);
         _snprintf_s(errBuf, 256, _TRUNCATE, "EvtNextChannelPath failed with %lu.\n", status);
         rb_raise(rb_eRuntimeError, errBuf);
       }
@@ -91,6 +95,12 @@ rb_winevt_channel_each(VALUE self)
     rb_yield(utf8str);
   }
 
+  if (winevtChannel->channels)
+    EvtClose(winevtChannel->channels);
+
+  if (buffer)
+    free(buffer);
+
   return Qnil;
 }
 

data/ext/winevt/winevt_query.c

@@ -229,7 +229,21 @@ rb_winevt_query_seek(VALUE self, VALUE bookmark_or_flag)
 }
 
 static VALUE
-rb_winevt_query_each(VALUE self)
+rb_winevt_query_close_handle(VALUE self)
+{
+  struct WinevtQuery *winevtQuery;
+
+  TypedData_Get_Struct(self, struct WinevtQuery, &rb_winevt_query_type, winevtQuery);
+
+  if (winevtQuery->event != NULL) {
+    EvtClose(winevtQuery->event);
+  }
+
+  return Qnil;
+}
+
+static VALUE
+rb_winevt_query_each_yield(VALUE self)
 {
   struct WinevtQuery *winevtQuery;
 
@@ -237,11 +251,24 @@ rb_winevt_query_each(VALUE self)
 
   TypedData_Get_Struct(self, struct WinevtQuery, &rb_winevt_query_type, winevtQuery);
 
+  rb_yield_values(3,
+                  rb_winevt_query_render(self),
+                  rb_winevt_query_message(self),
+                  rb_winevt_query_string_inserts(self));
+
+  return Qnil;
+}
+
+static VALUE
+rb_winevt_query_each(VALUE self)
+{
+  struct WinevtQuery *winevtQuery;
+
+  RETURN_ENUMERATOR(self, 0, 0);
+
+  TypedData_Get_Struct(self, struct WinevtQuery, &rb_winevt_query_type, winevtQuery);
   while (rb_winevt_query_next(self)) {
-    rb_yield_values(3,
-                    rb_winevt_query_render(self),
-                    rb_winevt_query_message(self),
-                    rb_winevt_query_string_inserts(self));
+    rb_ensure(rb_winevt_query_each_yield, self, rb_winevt_query_close_handle, self);
   }
 
   return Qnil;
@@ -262,5 +289,6 @@ void Init_winevt_query(VALUE rb_cEventLog)
   rb_define_method(rb_cQuery, "offset=", rb_winevt_query_set_offset, 1);
   rb_define_method(rb_cQuery, "timeout", rb_winevt_query_get_timeout, 0);
   rb_define_method(rb_cQuery, "timeout=", rb_winevt_query_set_timeout, 1);
+  rb_define_method(rb_cQuery, "close_handle", rb_winevt_query_close_handle, 0);
   rb_define_method(rb_cQuery, "each", rb_winevt_query_each, 0);
 }

data/ext/winevt/winevt_subscribe.c

@@ -114,6 +114,9 @@ rb_winevt_subscribe_subscribe(int argc, VALUE *argv, VALUE self)
 
   hSubscription = EvtSubscribe(NULL, hSignalEvent, path, query, hBookmark, NULL, NULL, flags);
 
+  ALLOCV_END(wpathBuf);
+  ALLOCV_END(wqueryBuf);
+
   winevtSubscribe->signalEvent = hSignalEvent;
   winevtSubscribe->subscription = hSubscription;
   if (hBookmark) {
@@ -192,6 +195,37 @@ rb_winevt_subscribe_string_inserts(VALUE self)
   return get_values(winevtSubscribe->event);
 }
 
+static VALUE
+rb_winevt_subscribe_close_handle(VALUE self)
+{
+  struct WinevtSubscribe *winevtSubscribe;
+
+  TypedData_Get_Struct(self, struct WinevtSubscribe, &rb_winevt_subscribe_type, winevtSubscribe);
+
+  if (winevtSubscribe->event != NULL) {
+    EvtClose(winevtSubscribe->event);
+  }
+
+  return Qnil;
+}
+
+static VALUE
+rb_winevt_subscribe_each_yield(VALUE self)
+{
+  struct WinevtSubscribe *winevtSubscribe;
+
+  RETURN_ENUMERATOR(self, 0, 0);
+
+  TypedData_Get_Struct(self, struct WinevtSubscribe, &rb_winevt_subscribe_type, winevtSubscribe);
+
+  rb_yield_values(3,
+                  rb_winevt_subscribe_render(self),
+                  rb_winevt_subscribe_message(self),
+                  rb_winevt_subscribe_string_inserts(self));
+
+  return Qnil;
+}
+
 static VALUE
 rb_winevt_subscribe_each(VALUE self)
 {
@@ -202,10 +236,7 @@ rb_winevt_subscribe_each(VALUE self)
   TypedData_Get_Struct(self, struct WinevtSubscribe, &rb_winevt_subscribe_type, winevtSubscribe);
 
   while (rb_winevt_subscribe_next(self)) {
-    rb_yield_values(3,
-                    rb_winevt_subscribe_render(self),
-                    rb_winevt_subscribe_message(self),
-                    rb_winevt_subscribe_string_inserts(self));
+    rb_ensure(rb_winevt_subscribe_each_yield, self, rb_winevt_subscribe_close_handle, self);
   }
 
   return Qnil;
@@ -238,6 +269,7 @@ void Init_winevt_subscribe(VALUE rb_cEventLog)
   rb_define_method(rb_cSubscribe, "message", rb_winevt_subscribe_message, 0);
   rb_define_method(rb_cSubscribe, "string_inserts", rb_winevt_subscribe_string_inserts, 0);
   rb_define_method(rb_cSubscribe, "each", rb_winevt_subscribe_each, 0);
+  rb_define_method(rb_cSubscribe, "close_handle", rb_winevt_subscribe_close_handle, 0);
   rb_define_method(rb_cSubscribe, "bookmark", rb_winevt_subscribe_get_bookmark, 0);
   rb_define_method(rb_cSubscribe, "tail?", rb_winevt_subscribe_tail_p, 0);
   rb_define_method(rb_cSubscribe, "tail=", rb_winevt_subscribe_set_tail, 1);

data/ext/winevt/winevt_utils.cpp

@@ -2,7 +2,7 @@
 #include <sddl.h>
 #include <stdlib.h>
 #include <string>
-#include <memory>
+#include <vector>
 
 char*
 wstr_to_mbstr(UINT cp, const WCHAR *wstr, int clen)
@@ -24,17 +24,20 @@ void free_allocated_mbstr(const char* str)
 VALUE
 wstr_to_rb_str(UINT cp, const WCHAR *wstr, int clen)
 {
+    VALUE vstr;
+    CHAR *ptr;
     int len = WideCharToMultiByte(cp, 0, wstr, clen, nullptr, 0, nullptr, nullptr);
-    std::unique_ptr<char[]> ptr(new char[len]);
-    WideCharToMultiByte(cp, 0, wstr, clen, ptr.get(), len, nullptr, nullptr);
-    VALUE str = rb_utf8_str_new_cstr(ptr.get());
+    ptr = (CHAR*)ALLOCV_N(CHAR, vstr, len);
+    WideCharToMultiByte(cp, 0, wstr, clen, ptr, len, nullptr, nullptr);
+    VALUE str = rb_utf8_str_new_cstr(ptr);
+    ALLOCV_END(vstr);
 
     return str;
 }
 
 WCHAR* render_event(EVT_HANDLE handle, DWORD flags)
 {
-  std::unique_ptr<WCHAR[]> buffer(new WCHAR[0]);
+  std::vector<WCHAR> buffer(1);
   ULONG      bufferSize = 0;
   ULONG      bufferSizeNeeded = 0;
   ULONG      status, count;
@@ -44,8 +47,10 @@ WCHAR* render_event(EVT_HANDLE handle, DWORD flags)
   do {
     if (bufferSizeNeeded > bufferSize) {
       bufferSize = bufferSizeNeeded;
-      buffer.reset(new WCHAR[bufferSize]);
-      if (buffer == nullptr) {
+      try {
+        buffer.resize(bufferSize);
+        buffer.shrink_to_fit();
+      } catch (std::bad_alloc e) {
         status = ERROR_OUTOFMEMORY;
         bufferSize = 0;
         rb_raise(rb_eWinevtQueryError, "Out of memory");
@@ -56,8 +61,8 @@ WCHAR* render_event(EVT_HANDLE handle, DWORD flags)
     if (EvtRender(nullptr,
                   handle,
                   flags,
-                  bufferSize,
-                  buffer.get(),
+                  buffer.size(),
+                  &buffer.front(),
                   &bufferSizeNeeded,
                   &count) != FALSE) {
       status = ERROR_SUCCESS;
@@ -81,7 +86,7 @@ WCHAR* render_event(EVT_HANDLE handle, DWORD flags)
     rb_raise(rb_eWinevtQueryError, "ErrorCode: %ld\nError: %s\n", status, RSTRING_PTR(errmsg));
   }
 
-  result = _wcsdup(buffer.get());
+  result = _wcsdup(&buffer.front());
 
   return result;
 }
@@ -98,7 +103,7 @@ static std::wstring guid_to_wstr(const GUID& guid) {
 
 VALUE get_values(EVT_HANDLE handle)
 {
-  std::wstring buffer;
+  std::vector<WCHAR> buffer;
   ULONG bufferSize = 0;
   ULONG bufferSizeNeeded = 0;
   DWORD status, propCount = 0;
@@ -118,6 +123,7 @@ VALUE get_values(EVT_HANDLE handle)
       bufferSize = bufferSizeNeeded;
       try {
         buffer.resize(bufferSize);
+        buffer.shrink_to_fit();
       } catch (std::bad_alloc e) {
         status = ERROR_OUTOFMEMORY;
         bufferSize = 0;
@@ -130,7 +136,7 @@ VALUE get_values(EVT_HANDLE handle)
                   handle,
                   EvtRenderEventValues,
                   buffer.size(),
-                  &buffer[0],
+                  &buffer.front(),
                   &bufferSizeNeeded,
                   &propCount) != FALSE) {
       status = ERROR_SUCCESS;
@@ -154,12 +160,12 @@ VALUE get_values(EVT_HANDLE handle)
     rb_raise(rb_eWinevtQueryError, "ErrorCode: %lu\nError: %s\n", status, RSTRING_PTR(errmsg));
   }
 
-  PEVT_VARIANT pRenderedValues = reinterpret_cast<PEVT_VARIANT>(const_cast<WCHAR *>(buffer.c_str()));
+  PEVT_VARIANT pRenderedValues = reinterpret_cast<PEVT_VARIANT>(&buffer.front());
   LARGE_INTEGER timestamp;
   SYSTEMTIME st;
   FILETIME ft;
-  CHAR strTime[128];
-  std::unique_ptr<CHAR[]> sResult(new CHAR[256]);
+  std::vector<CHAR> strTime(128);
+  std::vector<CHAR> sResult(256);
   VALUE rbObj;
 
   for (int i = 0; i < propCount; i++) {
@@ -172,7 +178,7 @@ VALUE get_values(EVT_HANDLE handle)
         rb_ary_push(userValues, rb_utf8_str_new_cstr("(NULL)"));
       } else {
         std::wstring wStr(pRenderedValues[i].StringVal);
-        rbObj = wstr_to_rb_str(CP_UTF8, wStr.c_str(), -1);
+        rbObj = wstr_to_rb_str(CP_UTF8, &wStr[0], -1);
         rb_ary_push(userValues, rbObj);
       }
       break;
@@ -216,16 +222,16 @@ VALUE get_values(EVT_HANDLE handle)
       rb_ary_push(userValues, rbObj);
       break;
     case EvtVarTypeSingle:
-      _snprintf_s(sResult.get(), 256, _TRUNCATE, "%f", pRenderedValues[i].SingleVal);
-      rb_ary_push(userValues, rb_utf8_str_new_cstr(sResult.get()));
+      _snprintf_s(&sResult.front(), sResult.size(), _TRUNCATE, "%f", pRenderedValues[i].SingleVal);
+      rb_ary_push(userValues, rb_utf8_str_new_cstr(&sResult.front()));
       break;
     case EvtVarTypeDouble:
-      _snprintf_s(sResult.get(), 256, _TRUNCATE, "%lf", pRenderedValues[i].DoubleVal);
-      rb_ary_push(userValues, rb_utf8_str_new_cstr(sResult.get()));
+      _snprintf_s(&sResult.front(), sResult.size(), _TRUNCATE, "%lf", pRenderedValues[i].DoubleVal);
+      rb_ary_push(userValues, rb_utf8_str_new_cstr(&sResult.front()));
       break;
     case EvtVarTypeBoolean:
-      result = const_cast<char *>(pRenderedValues[i].BooleanVal ? "true" : "false");
-      rb_ary_push(userValues, rb_utf8_str_new_cstr(result));
+      rbObj = pRenderedValues[i].BooleanVal ? Qtrue : Qfalse;
+      rb_ary_push(userValues, rbObj);
       break;
     case EvtVarTypeGuid:
       if (pRenderedValues[i].GuidVal != nullptr) {
@@ -246,11 +252,11 @@ VALUE get_values(EVT_HANDLE handle)
       ft.dwHighDateTime = timestamp.HighPart;
       ft.dwLowDateTime  = timestamp.LowPart;
       if (FileTimeToSystemTime( &ft, &st )) {
-        _snprintf_s(strTime, 128, _TRUNCATE, "%04d-%02d-%02d %02d:%02d:%02d.%dZ",
+        _snprintf_s(&strTime.front(), strTime.size(), _TRUNCATE, "%04d-%02d-%02d %02d:%02d:%02d.%dZ",
                     st.wYear , st.wMonth , st.wDay ,
                     st.wHour , st.wMinute , st.wSecond,
                     st.wMilliseconds);
-        rb_ary_push(userValues, rb_utf8_str_new_cstr(strTime));
+        rb_ary_push(userValues, rb_utf8_str_new_cstr(&strTime.front()));
       } else {
         rb_ary_push(userValues, rb_utf8_str_new_cstr("?"));
       }
@@ -258,11 +264,11 @@ VALUE get_values(EVT_HANDLE handle)
     case EvtVarTypeSysTime:
       if (pRenderedValues[i].SysTimeVal != nullptr) {
         st = *pRenderedValues[i].SysTimeVal;
-        _snprintf_s(strTime, 128, _TRUNCATE, "%04d-%02d-%02d %02d:%02d:%02d.%dZ",
+        _snprintf_s(&strTime.front(), strTime.size(), _TRUNCATE, "%04d-%02d-%02d %02d:%02d:%02d.%dZ",
                     st.wYear , st.wMonth , st.wDay ,
                     st.wHour , st.wMinute , st.wSecond,
                     st.wMilliseconds);
-        rb_ary_push(userValues, rb_utf8_str_new_cstr(strTime));
+        rb_ary_push(userValues, rb_utf8_str_new_cstr(&strTime.front()));
       } else {
         rb_ary_push(userValues, rb_utf8_str_new_cstr("?"));
       }
@@ -306,14 +312,14 @@ VALUE get_values(EVT_HANDLE handle)
   return userValues;
 }
 
-static std::wstring get_message(EVT_HANDLE hMetadata, EVT_HANDLE handle)
+static std::vector<WCHAR> get_message(EVT_HANDLE hMetadata, EVT_HANDLE handle)
 {
 #define BUFSIZE 4096
-  std::wstring result;
+  std::vector<WCHAR> result;
   ULONG  status;
   ULONG bufferSizeNeeded = 0;
   LPVOID lpMsgBuf;
-  std::wstring message(BUFSIZE, '\0');
+  std::vector<WCHAR> message(BUFSIZE);
 
   if (!EvtFormatMessage(hMetadata, handle, 0xffffffff, 0, nullptr, EvtFormatMessageEvent, message.size(), &message[0], &bufferSizeNeeded)) {
     status = GetLastError();
@@ -341,7 +347,8 @@ static std::wstring get_message(EVT_HANDLE hMetadata, EVT_HANDLE handle)
                          MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US),
                          reinterpret_cast<WCHAR *>(&lpMsgBuf), 0, nullptr);
 
-        result = reinterpret_cast<WCHAR *>(lpMsgBuf);
+        std::wstring ret(reinterpret_cast<WCHAR *>(lpMsgBuf));
+        std::copy( ret.begin(), ret.end(), std::back_inserter(result));
         LocalFree(lpMsgBuf);
 
         goto cleanup;
@@ -355,8 +362,9 @@ static std::wstring get_message(EVT_HANDLE hMetadata, EVT_HANDLE handle)
 
     if (status == ERROR_INSUFFICIENT_BUFFER) {
       message.resize(bufferSizeNeeded);
+      message.shrink_to_fit();
 
-      if(!EvtFormatMessage(hMetadata, handle, 0xffffffff, 0, nullptr, EvtFormatMessageEvent, message.size(), &message[0], &bufferSizeNeeded)) {
+      if(!EvtFormatMessage(hMetadata, handle, 0xffffffff, 0, nullptr, EvtFormatMessageEvent, message.size(), &message.front(), &bufferSizeNeeded)) {
         status = GetLastError();
 
         if (status != ERROR_EVT_UNRESOLVED_VALUE_INSERT) {
@@ -382,7 +390,8 @@ static std::wstring get_message(EVT_HANDLE hMetadata, EVT_HANDLE handle)
                              MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US),
                              reinterpret_cast<WCHAR *>(&lpMsgBuf), 0, nullptr);
 
-            result = reinterpret_cast<WCHAR *>(lpMsgBuf);
+            std::wstring ret(reinterpret_cast<WCHAR *>(lpMsgBuf));
+            std::copy( ret.begin(), ret.end(), std::back_inserter(result));
             LocalFree(lpMsgBuf);
 
             goto cleanup;
@@ -398,7 +407,7 @@ static std::wstring get_message(EVT_HANDLE hMetadata, EVT_HANDLE handle)
 
 cleanup:
 
-  return std::wstring(result);
+  return result;
 
 #undef BUFSIZE
 }
@@ -406,11 +415,11 @@ cleanup:
 WCHAR* get_description(EVT_HANDLE handle)
 {
 #define BUFSIZE 4096
-  std::wstring buffer(BUFSIZE, '\0');
+  std::vector<WCHAR> buffer(BUFSIZE);
   ULONG      bufferSize = 0;
   ULONG      bufferSizeNeeded = 0;
   ULONG      status, count;
-  std::wstring result;
+  std::vector<WCHAR> result;
   LPTSTR     msgBuf;
   EVT_HANDLE hMetadata = nullptr;
 
@@ -424,7 +433,7 @@ WCHAR* get_description(EVT_HANDLE handle)
                 handle,
                 EvtRenderEventValues,
                 buffer.size(),
-                &buffer[0],
+                &buffer.front(),
                 &bufferSizeNeeded,
                 &count) != FALSE) {
     status = ERROR_SUCCESS;
@@ -448,7 +457,7 @@ WCHAR* get_description(EVT_HANDLE handle)
   }
 
   // Obtain buffer as EVT_VARIANT pointer. To avoid ErrorCide 87 in EvtRender.
-  const PEVT_VARIANT values = reinterpret_cast<PEVT_VARIANT>(const_cast<WCHAR *>(buffer.c_str()));
+  const PEVT_VARIANT values = reinterpret_cast<PEVT_VARIANT>(&buffer.front());
 
   // Open publisher metadata
   hMetadata = EvtOpenPublisherMetadata(nullptr, values[0].StringVal, nullptr, MAKELCID(MAKELANGID(LANG_NEUTRAL, SUBLANG_NEUTRAL), SORT_DEFAULT), 0);
@@ -470,5 +479,5 @@ cleanup:
   if (hMetadata)
     EvtClose(hMetadata);
 
-  return _wcsdup(result.c_str());
+  return _wcsdup(result.data());
 }

data/lib/winevt/version.rb

@@ -1,3 +1,3 @@
 module Winevt
-  VERSION = "0.4.7.rc2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: winevt_c
 version: !ruby/object:Gem::Version
-  version: 0.4.7.rc2
+  version: 0.5.0
 platform: ruby
 authors:
 - Hiroshi Hatake
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-05 00:00:00.000000000 Z
+date: 2019-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,9 +133,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3