Bug report tool (microsoft#8633)

* added diagnostic tool project

* Add copy to a temp folder, escape private info and zip it

* Added diagnostic tool to installer

* zip folder path as cmd argument

* renamed project to BugReportTool

* do not use precompile headers for release

* Added zip lib

* Added license

* Delete old zip source files

* Use fork version while PR is not merged

* fix spelling

* exclude deps folder from spell checking

* exclude only zip

* removed redundant configuration from zip project

* fix spelling

* Add error handling to implementation

* Added build of BugReportTool.sln to pipeline

* Delete redundant info from BugReportTool.vcxproj

* Deleted submodule

* Added submodule

* fix build

* Restore nuget packages for BugReportTool.sln on CI

* spelling fix

* Use SettingsAPI

* changed git submodule

* added new sensitive info

* Removed zip project

* use json.h, add date to zipfolder, handle zip is not created

* fix spelling

* delete bad_alloc catch

* add new sensative info

* report monitor info

* report windows version

* fix spelling

* delete platform specific configuration

* fix output

Author: mykhailopylyp

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

@@ -222,8 +222,8 @@ CDeclaration
 cdpx
 cdpxwin
 CENTERALIGN
-Cfg
 cfg
+Cfg
 changecursor
 Changemove
 charset
@@ -317,8 +317,8 @@ constexpr
 contentdialog
 contentfiles
 CONTEXTHELP
-CONTEXTMENU
 contextmenu
+CONTEXTMENU
 CONTEXTMENUHANDLER
 CONTROLL
 CONTROLPARENT
@@ -362,6 +362,7 @@ crutkas
 CSearch
 CSettings
 csharp
+CSIDL
 csignal
 cso
 csproj
@@ -397,6 +398,7 @@ cxxopts
 CYMK
 CYSMICON
 cz
+cziplib
 Dac
 dacl
 DARKBLUE
@@ -407,12 +409,13 @@ DARKRED
 DARKTEAL
 DARKYELLOW
 Dataflows
+Datavalue
 DATAW
 davidegiacometti
 Dayof
 Dbg
-DBLEPSILON
 DBLCLKS
+DBLEPSILON
 DCOM
 dcomp
 DComposition
@@ -653,14 +656,14 @@ ENU
 enum
 ENUMITEMS
 EOAC
-EOL
 eol
+EOL
 epicgames
 ERASEBKGND
 EREOF
 EResize
-ERRORLEVEL
 errorlevel
+ERRORLEVEL
 ERRORMESSAGE
 ERRORTITLE
 esize
@@ -710,6 +713,7 @@ fancyzones
 FANCYZONESDRAWLAYOUTTEST
 FANCYZONESEDITOR
 Farbraum
+FARPROC
 Favicon
 fbdc
 fcharset
@@ -767,6 +771,7 @@ FULLNAME
 fullscreen
 func
 fwlink
+fwrite
 fx
 fxcop
 gabime
@@ -860,8 +865,8 @@ HLSL
 hmenu
 hmodule
 hmon
-HMONITOR
 hmonitor
+HMONITOR
 HOLDENTER
 HOLDESC
 homljgmgpmcbpjbnjpfijnhipfkiclkd
@@ -975,6 +980,7 @@ IInput
 IInspectable
 IIO
 IItem
+IJson
 IList
 ILogon
 IMAGEHLP
@@ -1239,6 +1245,7 @@ LPNMHDR
 LPNMHEADER
 LPNMLISTVIEW
 LPOLESTR
+LPOSVERSIONINFOEXW
 LPPOINT
 lprc
 LPRECT
@@ -1298,6 +1305,7 @@ MBUTTON
 MBUTTONDBLCLK
 MBUTTONDOWN
 MBUTTONUP
+mday
 Mdb
 MDICHILD
 MDL
@@ -1325,6 +1333,7 @@ millis
 mimetype
 Minimizeallwindows
 MINIMIZEBOX
+miniz
 MINMAXINFO
 Miracast
 mixin
@@ -1384,6 +1393,7 @@ msrc
 mst
 msvc
 msvcp
+msvs
 MTND
 Mul
 multiline
@@ -1499,7 +1509,9 @@ npm
 npmjs
 npos
 NResize
+ntdll
 NTFS
+NTSTATUS
 nuget
 nullopt
 nullptr
@@ -1552,6 +1564,7 @@ oss
 ostr
 ostream
 ostringstream
+OSVERSIONINFOEXW
 osx
 otating
 ouicompat
@@ -1692,8 +1705,8 @@ propkey
 propvarutil
 Prt
 prui
-PRVPANE
 prvpane
+PRVPANE
 psapi
 PSECURITY
 psfgao
@@ -1827,8 +1840,8 @@ roslyn
 royvou
 rpc
 RRF
-RSHIFT
 rshift
+RSHIFT
 Rsp
 rst
 Rstrtmgr
@@ -1885,13 +1898,14 @@ Sekan
 SENDCHANGE
 sendinput
 sendvirtualinput
+sensative
 serializationexception
 serializer
 serizalization
 serverside
 SETCONTEXT
-SETCURSOR
 setcursor
+SETCURSOR
 SETFOCUS
 SETFOREGROUND
 SETICON
@@ -1922,8 +1936,8 @@ SHELLDLL
 shellex
 SHELLEXECUTEINFO
 SHELLEXECUTEINFOW
-Shellscalingapi
 shellscalingapi
+Shellscalingapi
 Shelveset
 SHFILEINFO
 SHGFI
@@ -1977,8 +1991,8 @@ sketchapp
 SKIPDOTNETINSTALL
 SKIPOWNPROCESS
 sku
-Skype
 SKYBLUE
+Skype
 SLGP
 Slideshow
 sln
@@ -2101,8 +2115,8 @@ SYSDEADCHAR
 SYSICONINDEX
 SYSKEY
 syskeydown
-SYSKEYUP
 syskeyup
+SYSKEYUP
 syslog
 SYSMENU
 systemd
@@ -2250,12 +2264,13 @@ uninstalling
 uninstantiated
 Uniq
 uniquifier
-Uniquifies
 uniquifies
+Uniquifies
 unittests
 unk
 unknwn
 UNLEN
+unlicense
 Unmap
 UNORM
 Unpublish
@@ -2361,8 +2376,8 @@ wcslen
 wcsncmp
 wcsnicmp
 wdp
-WDS
 wds
+WDS
 wdupenv
 weakme
 webapp
@@ -2379,13 +2394,14 @@ Whichdoes
 whitespaces
 WIC
 Wifi
+wifstream
 wih
 wiki
 wikipedia
 wil
 wildcards
-WINAPI
 winapi
+WINAPI
 winauto
 wincolor
 windef
@@ -2430,6 +2446,7 @@ wixproj
 wixtoolset
 WIXUI
 WKSG
+wmain
 wmi
 WMKEYDOWN
 WMKEYUP
@@ -2454,6 +2471,7 @@ wox
 wparam
 wpf
 wpr
+wprintf
 wprp
 wregex
 WResize
@@ -2522,6 +2540,7 @@ Zc
 ZEROINIT
 zh
 ZIndex
+zipfolder
 zm
 zom
 zonable

.gitmodules

@@ -1,11 +1,12 @@
 [submodule "deps/spdlog"]
 	path = deps/spdlog
 	url = https://github.com/gabime/spdlog.git
-
 [submodule "deps/cxxopts"]
 	path = deps/cxxopts
 	url = https://github.com/jarro2783/cxxopts.git
-
 [submodule "deps/expected-lite"]
 	path = deps/expected-lite
 	url = https://github.com/martinmoene/expected-lite.git
+[submodule "deps/cziplib"]
+	path = deps/cziplib
+	url = https://github.com/kuba--/zip.git

.pipelines/ci/templates/build-powertoys-steps.yml

@@ -36,6 +36,25 @@ steps:
     msbuildArgs: ${{ parameters.additionalBuildArguments }}
     maximumCpuCount: true
 
+- task: NuGetCommand@2
+  displayName: Restore NuGet packages for BugReportTool.sln
+  inputs:
+    command: restore
+    feedsToUse: config
+    configPath: NuGet.config
+    restoreSolution: src\bug-report\BugReportTool\BugReportTool.sln
+    restoreDirectory: '$(Build.SourcesDirectory)\src\bug-report\BugReportTool\packages'
+
+- task: VSBuild@1
+  displayName: 'Build BugReportTool.sln'
+  inputs:
+    solution: '**\BugReportTool.sln'
+    vsVersion: 16.0
+    platform: '$(BuildPlatform)'
+    configuration: '$(BuildConfiguration)'
+    msbuildArgs: ${{ parameters.additionalBuildArguments }}
+    maximumCpuCount: true
+
 - task: NuGetCommand@2
   displayName: Restore NuGet packages for PowerToysSetup.sln
   inputs:

NOTICE.md

@@ -236,4 +236,31 @@ FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 
+### zip
+**Source**: https://github.com/kuba--/zip
+
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>
 

deps/cziplib

@@ -12,7 +12,9 @@
 
   <?define RepoDir="$(var.ProjectDir)..\..\" ?>
   <?define BinX64Dir="$(var.RepoDir)x64\$(var.Configuration)\" ?>
-  <Product Id="*"
+  <?define BugReportToolDir="$(var.RepoDir)src\bug-report\BugReportTool\x64\$(var.Configuration)\" ?>
+
+	<Product Id="*"
        Name="PowerToys (Preview)"
        Language="1033"
        Version="$(var.Version)"
@@ -46,6 +48,7 @@
       <ComponentGroupRef Id="CoreComponents" />
       <ComponentGroupRef Id="ResourcesComponents" />
       <ComponentGroupRef Id="LauncherComponents" />
+	  <ComponentRef Id="BugReportTool"/>
     </Feature>
     <SetProperty Id="ARPINSTALLLOCATION" Value="[INSTALLFOLDER]" After="CostFinalize" />
 
@@ -205,6 +208,7 @@
       <Directory Id="ProgramFiles64Folder">
         <Directory Id="INSTALLFOLDER" Name="PowerToys">
           <Directory Id="SvgsInstallFolder" Name="svgs"/>
+	      <Directory Id="BugReportToolFolder" Name="BugReportTool"/>
           <Directory Id="ModulesInstallFolder" Name="modules">
             <Directory Id="ImageResizerInstallFolder" Name="$(var.ImageResizerProjectName)" />
             <Directory Id="PowerRenameInstallFolder" Name="$(var.PowerRenameProjectName)"/>
@@ -336,6 +340,11 @@
         <?endforeach?>
       </Component>
     </DirectoryRef>
+	<DirectoryRef Id="BugReportToolFolder" FileSource="$(var.BugReportToolDir)">
+		<Component Id="BugReportTool" Guid="0F8E3E9F-2E86-4660-A3BF-AE4DD431B93C" Win64="yes">
+			<File Source="$(var.BugReportToolDir)BugReportTool.exe" />
+		</Component>
+	</DirectoryRef>
     <DirectoryRef Id="SvgsInstallFolder" FileSource="$(var.BinX64Dir)svgs\">
       <Component Id="PowerToysSvgs" Guid="7C4D4EED-9338-423D-992C-DCE02F3E2D35" Win64="yes">
         <File Source="$(var.BinX64Dir)svgs\0.svg" />