Make Windows error reporting more robust

https://msdn.microsoft.com/en-us/library/ms679351 describes that
"it is unsafe to take an arbitrary system error code returned from an API
and use FORMAT_MESSAGE_FROM_SYSTEM without FORMAT_MESSAGE_IGNORE_INSERTS"
Previously in case when an error string would contain inserts, function
returned error, so the error message wasn't shown (at least it didn't
crash, thanks to nullptr as the function's last argument).

As the function may fail, we now pre-nullify the buffer pointer to avoid
dereferencing uninitialized pointer later (though at least for some
Windows versions, the function nullifies the pointer in case of
FORMAT_MESSAGE_ALLOCATE_BUFFER, but there's no explicit guarantee of this).

Also release of allocated buffer is changed to recommended use of
HeapFree.

The code that doesn't make use of OUString is left directly calling
FormatMessage, to avoid introducing new dependencies. Where it makes
sense, we now use WindowsErrorString from <comphelper/windowserrorstring.hxx>

Change-Id: I834c08eb6d92987e7d3d01e2c36ec55e42aea848
Reviewed-on: https://gerrit.libreoffice.org/44206Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
Reviewed-by: Mike Kaganski <mike.kaganski@collabora.com>

comphelper/source/windows/windows_process.cxx

@@ -254,7 +254,7 @@ WinLaunchChild(const wchar_t *exePath,
                        nullptr);
         wprintf(L"Error restarting: %s\n", lpMsgBuf ? lpMsgBuf : L"(null)");
         if (lpMsgBuf)
-            LocalFree(lpMsgBuf);
+            HeapFree(GetProcessHeap(), 0, lpMsgBuf);
     }
 
     free(cl);

dbaccess/win32/source/odbcconfig/odbcconfig.cxx

@@ -44,10 +44,9 @@ int displayLastError()
 {
     DWORD   dwError = GetLastError();
 
-    LPVOID lpMsgBuf;
+    LPVOID lpMsgBuf = nullptr;
     FormatMessageW(
-        FORMAT_MESSAGE_ALLOCATE_BUFFER |
-        FORMAT_MESSAGE_FROM_SYSTEM,
+        FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
         nullptr,
         dwError,
         MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
@@ -60,7 +59,7 @@ int displayLastError()
     MessageBoxW( nullptr, static_cast<LPCWSTR>(lpMsgBuf), nullptr, MB_OK | MB_ICONERROR );
 
     // Free the buffer.
-    LocalFree( lpMsgBuf );
+    HeapFree( GetProcessHeap(), 0, lpMsgBuf );
 
     return dwError;
 }

desktop/win32/source/applauncher/launcher.cxx

@@ -81,11 +81,10 @@ extern "C" int APIENTRY wWinMain( HINSTANCE, HINSTANCE, LPWSTR, int )
 
     DWORD dwError = GetLastError();
 
-    LPWSTR lpMsgBuf;
+    LPWSTR lpMsgBuf = nullptr;
 
     FormatMessageW(
-        FORMAT_MESSAGE_ALLOCATE_BUFFER |
-        FORMAT_MESSAGE_FROM_SYSTEM,
+        FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
         nullptr,
         dwError,
         MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
@@ -98,7 +97,7 @@ extern "C" int APIENTRY wWinMain( HINSTANCE, HINSTANCE, LPWSTR, int )
     MessageBoxW( nullptr, lpMsgBuf, nullptr, MB_OK | MB_ICONERROR );
 
     // Free the buffer.
-    LocalFree( lpMsgBuf );
+    HeapFree( GetProcessHeap(), 0, lpMsgBuf );
 
     return dwError;
 }

desktop/win32/source/loader.cxx

@@ -27,10 +27,10 @@ void fail()
 {
     LPWSTR buf = nullptr;
     FormatMessageW(
-        FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM, nullptr,
+        FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, nullptr,
         GetLastError(), 0, reinterpret_cast< LPWSTR >(&buf), 0, nullptr);
     MessageBoxW(nullptr, buf, nullptr, MB_OK | MB_ICONERROR);
-    LocalFree(buf);
+    HeapFree(GetProcessHeap(), 0, buf);
     TerminateProcess(GetCurrentProcess(), 255);
 }
 

extensions/source/activex/SOActiveX.cxx

@@ -44,10 +44,9 @@
 
 void OutputError_Impl( HWND hw, HRESULT ErrorCode )
 {
-    LPWSTR sMessage;
+    LPWSTR sMessage = nullptr;
     FormatMessageW(
-        FORMAT_MESSAGE_ALLOCATE_BUFFER |
-        FORMAT_MESSAGE_FROM_SYSTEM,
+        FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
         nullptr,
         ErrorCode,
         MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
@@ -56,7 +55,7 @@ void OutputError_Impl( HWND hw, HRESULT ErrorCode )
         nullptr
     );
     MessageBoxW( hw, sMessage, nullptr, MB_OK | MB_ICONINFORMATION );
-    LocalFree( sMessage );
+    HeapFree( GetProcessHeap(), 0, sMessage );
 }
 
 HRESULT ExecuteFunc( IDispatch* idispUnoObject,

include/LibreOfficeKit/LibreOfficeKitInit.h

@@ -100,7 +100,8 @@ extern "C"
     static char *lok_dlerror(void)
     {
         LPSTR buf = NULL;
-        FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM, NULL, GetLastError(), 0, reinterpret_cast<LPSTR>(&buf), 0, NULL);
+        FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
+            NULL, GetLastError(), 0, reinterpret_cast<LPSTR>(&buf), 0, NULL);
         return buf;
     }
 

include/comphelper/windowserrorstring.hxx

@@ -21,7 +21,7 @@ inline OUString WindowsErrorString(DWORD nErrorCode)
 {
     LPWSTR pMsgBuf;
 
-    if (FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
+    if (FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
                        nullptr,
                        nErrorCode,
                        MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
@@ -33,7 +33,7 @@ inline OUString WindowsErrorString(DWORD nErrorCode)
     OUString result(o3tl::toU(pMsgBuf));
     result.endsWith("\r\n", &result);
 
-    LocalFree(pMsgBuf);
+    HeapFree(GetProcessHeap(), 0, pMsgBuf);
 
     return result;
 }

sal/osl/w32/socket.cxx

@@ -24,6 +24,7 @@
 #include <rtl/alloc.h>
 #include <sal/log.hxx>
 #include <o3tl/char16_t2wchar_t.hxx>
+#include <comphelper/windowserrorstring.hxx>
 
 #include "sockimpl.hxx"
 
@@ -791,13 +792,7 @@ oslSocket SAL_CALL osl_createSocket(
     if(pSocket->m_Socket == OSL_INVALID_SOCKET)
     {
         int nErrno = WSAGetLastError();
-        wchar_t *sErr = nullptr;
-        FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
-                       nullptr, nErrno,
-                       MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
-                       reinterpret_cast<LPWSTR>(&sErr), 0, nullptr);
-        SAL_WARN("sal.osl", "socket creation failed: (" << nErrno << ") " << sErr);
-        LocalFree(sErr);
+        SAL_WARN("sal.osl", "socket creation failed: (" << nErrno << "): " << WindowsErrorString(nErrno));
 
         destroySocketImpl(pSocket);
         pSocket = nullptr;

shell/source/win32/spsupp/COMOpenDocuments.cxx

@@ -51,7 +51,7 @@ HRESULT LOStart(const wchar_t* sModeArg, const wchar_t* sFilePath, bool bDoSecur
     if (CreateProcessW(nullptr, sCommandLine, nullptr, nullptr, FALSE, 0, nullptr, nullptr, &si, &pi) == FALSE)
     {
         DWORD dwError = GetLastError();
-        wchar_t* sMsgBuf;
+        wchar_t* sMsgBuf = nullptr;
         FormatMessageW(
             FORMAT_MESSAGE_ALLOCATE_BUFFER |
             FORMAT_MESSAGE_FROM_SYSTEM |
@@ -65,7 +65,7 @@ HRESULT LOStart(const wchar_t* sModeArg, const wchar_t* sFilePath, bool bDoSecur
         size_t nBufSize = wcslen(sMsgBuf) + 100;
         std::vector<wchar_t> sDisplayBuf(nBufSize);
         swprintf(sDisplayBuf.data(), nBufSize, L"Could not start LibreOffice. Error is 0x%08X:\n\n%s", dwError, sMsgBuf);
-        LocalFree(sMsgBuf);
+        HeapFree(GetProcessHeap(), 0, sMsgBuf);
 
         // Report the error to user and return error
         MessageBoxW(nullptr, sDisplayBuf.data(), nullptr, MB_ICONERROR);

vcl/win/window/salobj.cxx

@@ -29,6 +29,8 @@
 #include <win/salframe.h>
 #include <win/salobj.h>
 
+#include <comphelper/windowserrorstring.hxx>
+
 static bool ImplIsSysWindowOrChild( HWND hWndParent, HWND hWndChild )
 {
     if ( hWndParent == hWndChild )
@@ -522,16 +524,8 @@ SalObject* ImplSalCreateObject( WinSalInstance* pInst, WinSalFrame* pParent )
 
         if ( !hWndChild )
         {
-#if OSL_DEBUG_LEVEL > 1
-            wchar_t *msg = NULL;
-            FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER
-                          |FORMAT_MESSAGE_IGNORE_INSERTS
-                          |FORMAT_MESSAGE_FROM_SYSTEM,
-                           NULL, GetLastError(), 0,
-                           (LPWSTR) &msg, 0, NULL);
-            MessageBoxW(NULL, msg, L"CreateWindowExW failed", MB_OK);
-            HeapFree(GetProcessHeap(), msg);
-#endif
+            SAL_WARN("vcl", "CreateWindowExW failed: " << WindowsErrorString(GetLastError()));
+
             delete pObject;
             return nullptr;
         }