Bug report tool for registry (#9213)

* wip

* Improved registry bug reporting

* Don't use macros

* Ignore spelling of NLSTEXT in macro

* Various improvements

* Move functions to separate files
* Rename result file to registry-report-info.txt
* Rename a poorly named function in ReportMonitorInfo.cpp
* Restrict scope of symbols in these .cpp files

Co-authored-by: Davide <davide.giacometti@outlook.it>

.github/actions/spell-check/expect.txt

@@ -1446,6 +1446,7 @@ nielslaute
 NIF
 NLD
 NLog
+NLSTEXT
 NMLVEMPTYMARKUP
 NOACTIVATE
 noactive

tools/BugReportTool/BugReportTool/BugReportTool.vcxproj

@@ -38,6 +38,7 @@
     </ClCompile>
     <ClCompile Include="ReportMonitorInfo.cpp" />
     <ClCompile Include="Main.cpp" />
+    <ClCompile Include="ReportRegistry.cpp" />
     <ClCompile Include="ZipTools\zipfolder.cpp" />
   </ItemGroup>
   <ItemGroup>
@@ -53,6 +54,7 @@
     <ClInclude Include="..\..\..\deps\cziplib\src\zip.h" />
     <ClInclude Include="ReportMonitorInfo.h" />
     <ClInclude Include="..\..\..\common\utils\json.h" />
+    <ClInclude Include="ReportRegistry.h" />
     <ClInclude Include="ZipTools\zipfolder.h" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />

tools/BugReportTool/BugReportTool/BugReportTool.vcxproj.filters

@@ -10,6 +10,7 @@
     </ClCompile>
     <ClCompile Include="..\..\..\deps\cziplib\src\zip.c" />
     <ClCompile Include="ReportMonitorInfo.cpp" />
+    <ClCompile Include="ReportRegistry.cpp" />
   </ItemGroup>
   <ItemGroup>
     <Filter Include="ZipTools">
@@ -24,5 +25,6 @@
     <ClInclude Include="..\..\..\deps\cziplib\src\miniz.h" />
     <ClInclude Include="..\..\..\deps\cziplib\src\zip.h" />
     <ClInclude Include="ReportMonitorInfo.h" />
+    <ClInclude Include="ReportRegistry.h" />
   </ItemGroup>
 </Project>

tools/BugReportTool/BugReportTool/Main.cpp

@@ -13,6 +13,7 @@
 #include <common/utils/exec.h>
 
 #include "ReportMonitorInfo.h"
+#include "ReportRegistry.h"
 using namespace std;
 using namespace std::filesystem;
 using namespace winrt::Windows::Data::Json;
@@ -148,27 +149,6 @@ void hideUserPrivateInfo(const filesystem::path& dir)
     }
 }
 
-void reportMonitorInfo(const filesystem::path& tmpDir)
-{
-    auto monitorReportPath = tmpDir;
-    monitorReportPath.append("monitor-report-info.txt");
-
-    try
-    {
-        wofstream monitorReport(monitorReportPath);
-        monitorReport << "GetSystemMetrics = " << GetSystemMetrics(SM_CMONITORS) << '\n';
-        report(monitorReport);
-    }
-    catch (std::exception& ex)
-    {
-        printf("Failed to report monitor info. %s\n", ex.what());
-    }
-    catch (...)
-    {
-        printf("Failed to report monitor info\n");
-    }
-}
-
 void reportWindowsVersion(const filesystem::path& tmpDir)
 {
     auto versionReportPath = tmpDir;
@@ -285,6 +265,9 @@ int wmain(int argc, wchar_t* argv[], wchar_t*)
     // Write dotnet installation info to the temporary folder
     reportDotNetInstallationInfo(tmpDir);
 
+    // Write registry to the temporary folder
+    reportRegistry(tmpDir);
+
     // Zip folder
     auto zipPath = path::path(saveZipPath);
     std::string reportFilename{"PowerToysReport_"};
@@ -304,4 +287,4 @@ int wmain(int argc, wchar_t* argv[], wchar_t*)
 
     deleteFolder(tmpDir);
     return 0;
-}
+}

tools/BugReportTool/BugReportTool/ReportMonitorInfo.cpp

@@ -1,56 +1,82 @@
 #pragma once
 #include "ReportMonitorInfo.h"
 #include <Windows.h>
+#include <filesystem>
 #include "../../../src/common/utils/winapi_error.h"
+using namespace std;
 
-int report(std::wostream& os)
+namespace
 {
-    struct capture
+    int buildMonitorInfoReport(std::wostream& os)
     {
-        std::wostream* os = nullptr;
-    };
+        struct capture
+        {
+            std::wostream* os = nullptr;
+        };
 
-    auto callback = [](HMONITOR monitor, HDC, RECT*, LPARAM prm) -> BOOL {
-        std::wostream& os = *((capture*)prm)->os;
-        MONITORINFOEX mi;
-        mi.cbSize = sizeof(mi);
+        auto callback = [](HMONITOR monitor, HDC, RECT*, LPARAM prm) -> BOOL {
+            std::wostream& os = *((capture*)prm)->os;
+            MONITORINFOEX mi;
+            mi.cbSize = sizeof(mi);
 
-        if (GetMonitorInfoW(monitor, &mi))
-        {
-            os << "GetMonitorInfo OK\n";
-            DISPLAY_DEVICE displayDevice = { sizeof(displayDevice) };
+            if (GetMonitorInfoW(monitor, &mi))
+            {
+                os << "GetMonitorInfo OK\n";
+                DISPLAY_DEVICE displayDevice = { sizeof(displayDevice) };
 
-            DWORD i = 0;
-            while (EnumDisplayDevicesW(mi.szDevice, i++, &displayDevice, EDD_GET_DEVICE_INTERFACE_NAME))
+                DWORD i = 0;
+                while (EnumDisplayDevicesW(mi.szDevice, i++, &displayDevice, EDD_GET_DEVICE_INTERFACE_NAME))
+                {
+                    const bool active = displayDevice.StateFlags & DISPLAY_DEVICE_ACTIVE;
+                    const bool mirroring = displayDevice.StateFlags & DISPLAY_DEVICE_MIRRORING_DRIVER;
+                    os << "EnumDisplayDevices OK:\n"
+                        << "\tMirroring = " << mirroring << '\n'
+                        << "\tActive = " << active << '\n'
+                        << "\tDeviceID = " << displayDevice.DeviceID << '\n'
+                        << "\tDeviceKey = " << displayDevice.DeviceKey << '\n'
+                        << "\tDeviceName = " << displayDevice.DeviceName << '\n'
+                        << "\tDeviceString = " << displayDevice.DeviceString << '\n';
+                }
+            }
+            else
             {
-                const bool active = displayDevice.StateFlags & DISPLAY_DEVICE_ACTIVE;
-                const bool mirroring = displayDevice.StateFlags & DISPLAY_DEVICE_MIRRORING_DRIVER;
-                os << "EnumDisplayDevices OK:\n"
-                   << "\tMirroring = " << mirroring << '\n'
-                   << "\tActive = " << active << '\n'
-                   << "\tDeviceID = " << displayDevice.DeviceID << '\n'
-                   << "\tDeviceKey = " << displayDevice.DeviceKey << '\n'
-                   << "\tDeviceName = " << displayDevice.DeviceName << '\n'
-                   << "\tDeviceString = " << displayDevice.DeviceString << '\n';
+                auto message = get_last_error_message(GetLastError());
+                os << "GetMonitorInfo FAILED: " << (message.has_value() ? message.value() : L"") << '\n';
             }
+            return TRUE;
+        };
+        capture c;
+        c.os = &os;
+        if (EnumDisplayMonitors(nullptr, nullptr, callback, (LPARAM)&c))
+        {
+            os << "EnumDisplayMonitors OK\n";
         }
         else
         {
             auto message = get_last_error_message(GetLastError());
-            os << "GetMonitorInfo FAILED: " << (message.has_value() ? message.value() : L"") << '\n';
+            os << "EnumDisplayMonitors FAILED: " << (message.has_value() ? message.value() : L"") << '\n';
         }
-        return TRUE;
-    };
-    capture c;
-    c.os = &os;
-    if (EnumDisplayMonitors(nullptr, nullptr, callback, (LPARAM)&c))
+        return 0;
+    }
+}
+
+void reportMonitorInfo(const filesystem::path& tmpDir)
+{
+    auto monitorReportPath = tmpDir;
+    monitorReportPath.append("monitor-report-info.txt");
+
+    try
+    {
+        wofstream monitorReport(monitorReportPath);
+        monitorReport << "GetSystemMetrics = " << GetSystemMetrics(SM_CMONITORS) << '\n';
+        buildMonitorInfoReport(monitorReport);
+    }
+    catch (std::exception& ex)
     {
-        os << "EnumDisplayMonitors OK\n";
+        printf("Failed to report monitor info. %s\n", ex.what());
     }
-    else
+    catch (...)
     {
-        auto message = get_last_error_message(GetLastError());
-        os << "EnumDisplayMonitors FAILED: " << (message.has_value() ? message.value() : L"") << '\n';
+        printf("Failed to report monitor info\n");
     }
-    return 0;
-}
+}

tools/BugReportTool/BugReportTool/ReportMonitorInfo.h

@@ -1,4 +1,4 @@
 #pragma once
 #include <fstream>
 
-int report(std::wostream& os);
+void reportMonitorInfo(const std::filesystem::path& tmpDir);