fixed resource embedding and proper error handling when permissions are missing

Author: Jan Wilmans

.gitattributes

@@ -1,2 +1,13 @@
 *     text=auto eol=crlf
 *.sh  text=auto eol=lf
+
+# Define binary files
+*.sys     -text diff
+*.sln     -text diff
+*.suo     -text diff
+*.vcxproj -text diff
+*.gif     -text diff
+*.ico     -text diff
+*.jpeg    -text diff
+*.jpg     -text diff
+*.png     -text diff

application/DebugViewpp/DebugView++.cpp

@@ -14,6 +14,9 @@
 
 #include "atleverything.h"
 
+#include <filesystem>
+#include <cstdlib>  // for std::getenv
+
 //#define ENABLE_CRASHPAD
 #ifdef ENABLE_CRASHPAD
 #include "crashpad.h"
@@ -88,25 +91,26 @@ int ForwardMessagesFromPipe(HANDLE hPipe)
     return 0;
 }
 
-void WriteDriverFromResource()
+class DebugConsole
 {
-    HRSRC hRes = FindResource(NULL, MAKEINTRESOURCE(IDR_DBGV_DRIVER), RT_RCDATA);
-    if (hRes)
+public:
+    DebugConsole()
     {
-        HGLOBAL hLoadedRes = LoadResource(NULL, hRes);
-        if (hLoadedRes)
-        {
-            DWORD dwSize = SizeofResource(NULL, hRes);
-            void* pLockedRes = LockResource(hLoadedRes);
-            if (pLockedRes)
-            {
-                std::ofstream outFile("dbgv.sys", std::ios::binary);
-                outFile.write(static_cast<const char*>(pLockedRes), dwSize);
-                outFile.close();
-            }
-        }
+        ::AllocConsole();
+        ::freopen_s(&standardOut, "CONOUT$", "wb", stdout);
+        std::cout.clear();
     }
-}
+
+    ~DebugConsole()
+    {
+        fclose(standardOut);
+        fclose(stdout);
+        FreeConsole();
+    }
+
+private:
+    FILE* standardOut = nullptr;
+};
 
 int Main(HINSTANCE hInstance, HINSTANCE /*hPrevInstance*/, LPWSTR /*lpstrCmdLine*/, int cmdShow)
 {
@@ -121,13 +125,11 @@ int Main(HINSTANCE hInstance, HINSTANCE /*hPrevInstance*/, LPWSTR /*lpstrCmdLine
 
     AtlInitCommonControls(ICC_BAR_CLASSES); // add flags to support other controls
 
-#ifdef CONSOLE_DEBUG
-    FILE* standardOut;
-    AllocConsole();
-    freopen_s(&standardOut, "CONOUT$", "wb", stdout);
-    auto fileGuard = make_guard([standardOut] { fclose(standardOut); });
-    std::cout.clear();
-#endif
+    std::unique_ptr<DebugConsole> debugConsole;
+    if (std::getenv("DEBUGVIEWPP_CONSOLE_DEBUG") != nullptr)
+    {
+        debugConsole = std::make_unique<DebugConsole>();
+    }
 
     CAppModuleInitialization moduleInit(_Module, hInstance);
 

application/DebugViewpp/MainFrame.cpp

@@ -192,7 +192,10 @@ CMainFrame::CMainFrame() :
     m_notifyIconData.cbSize = 0;
 }
 
-CMainFrame::~CMainFrame() = default;
+CMainFrame::~CMainFrame()
+{
+    RemoveDriver();
+}
 
 void CMainFrame::SetLogging()
 {
@@ -284,11 +287,6 @@ void CMainFrame::OnClose()
         Shell_NotifyIcon(NIM_DELETE, &m_notifyIconData);
         m_notifyIconData.cbSize = 0;
     }
-
-#ifdef CONSOLE_DEBUG
-    fclose(stdout);
-    FreeConsole();
-#endif
 }
 
 LRESULT CMainFrame::OnQueryEndSession(WPARAM /*unused*/, LPARAM /*unused*/)
@@ -1519,18 +1517,51 @@ void CMainFrame::OnLogGlobal(UINT /*uNotifyCode*/, int /*nID*/, CWindow /*wndCtl
     UpdateTitle();
 }
 
+static const auto driver_name = "dbgv.sys";
+
+void WriteDriverFromResource()
+{
+    if (std::filesystem::exists(driver_name))
+    {
+        return;
+    }
+    HRSRC hRes = FindResource(NULL, MAKEINTRESOURCE(IDR_DBGV_DRIVER), RT_RCDATA);
+    if (hRes)
+    {
+        HGLOBAL hLoadedRes = LoadResource(NULL, hRes);
+        if (hLoadedRes)
+        {
+            DWORD dwSize = SizeofResource(NULL, hRes);
+            void* pLockedRes = LockResource(hLoadedRes);
+            if (pLockedRes)
+            {
+                std::ofstream outFile(driver_name, std::ios::binary);
+                outFile.write(static_cast<const char*>(pLockedRes), dwSize);
+                outFile.close();
+            }
+        }
+    }
+}
+
+void RemoveDriver()
+{
+    std::filesystem::remove(driver_name);
+}
+
 void CMainFrame::OnLogKernel(UINT /*uNotifyCode*/, int /*nID*/, CWindow /*wndCtl*/)
 {
     m_tryKernel = (m_pKernelReader == nullptr);
 
     if (m_tryKernel)
     {
+        WriteDriverFromResource();
         Resume();
     }
     else
     {
         m_logSources.Remove(m_pKernelReader);
         m_pKernelReader = nullptr;
+        RemoveDriver();
     }
     UpdateTitle();
 }

application/DebugViewpp/MainFrame.h

@@ -44,6 +44,8 @@ class DbgviewReader;
 
 using SelectedTabItem = CLogViewTabItem;
 
+void RemoveDriver();
+
 class CMainFrame : public CTabbedFrameImpl<CMainFrame, CDotNetTabCtrl<SelectedTabItem>>,
                    public CUpdateUI<CMainFrame>,
                    public ExceptionHandler<CMainFrame, std::exception>,

application/DebugViewpp/res/Dbgv.sys

@@ -141,3 +141,4 @@
 #define _APS_NEXT_SYMED_VALUE 107
 #endif
 #endif
+

application/DebugViewpp/resource.h

@@ -1,2 +1,2 @@
-#define VERSION 1,9,0,58 
-#define VERSION_STR "1.9.0.58" 
+#define VERSION 1,9,0,63 
+#define VERSION_STR "1.9.0.63" 

application/DebugViewpp/version.h

@@ -3,6 +3,6 @@
     <?define ProductVersion.Major="1" ?> 
     <?define ProductVersion.Minor="9" ?> 
     <?define ProductVersion.Revision="0" ?> 
-    <?define ProductVersion.Build="58" ?> 
-    <?define ProductVersion="1.9.0.58" ?> 
+    <?define ProductVersion.Build="63" ?> 
+    <?define ProductVersion="1.9.0.63" ?> 
 </Include> 

application/DebugViewpp/version.wxi

@@ -48,14 +48,15 @@ void UninstallKernelMessagesDriver()
     SC_HANDLE hSCManager = OpenSCManager(NULL, NULL, SC_MANAGER_ALL_ACCESS);
     if (!hSCManager)
     {
-        std::cout << "Failed to open Service Control Manager. Error: " << GetLastError() << std::endl;
+        std::cout << "Failed to open Service Control Manager for uninstall. Error: " << GetLastError() << std::endl;
         return;
     }
 
     SC_HANDLE hService = OpenServiceA(hSCManager, DRIVER_SERVICE_NAME, DELETE);
     if (!hService)
     {
-        std::cout << "Failed to open service. Error: " << GetLastError() << std::endl;
+        // this happens when the service is first loaded, because we always uninstall before installing
+        // std::cout << "Failed to open service for uninstall. Error: " << GetLastError() << std::endl;
         CloseServiceHandle(hSCManager);
         return;
     }

application/DebugViewppLib/Debugview_kernel_client.cpp

@@ -23,8 +23,8 @@ void KernelReader::StartListening()
         NULL));
     if (handle.get() == INVALID_HANDLE_VALUE)
     {
-        AddMessage(0, "internal", "Could not connected to kernel messages driver");
-        return;
+        printf("Could not connect to kernel messages driver");
+        throw std::runtime_error("Could not connect to kernel messages driver");
     }
 
     // enable capture
@@ -34,7 +34,7 @@ void KernelReader::StartListening()
     if (!bRet)
     {
         printf("DBGV_CAPTURE_KERNEL failed, err=%d\n", ::GetLastError());
-        return;
+        throw std::runtime_error("Could not connect to kernel messages driver");
     }
 
     m_handle = std::move(handle);