Fall back to TerminalApp.dll's version when we're unpackaged (#5274)

This pull request makes sure we still get a usable (for troubleshooting purposes) version number in the about dialog and settings file when the user is running unpackaged. This introduces a magic LCID constant (0x0409).B y default, Package ES emits version resource information that says we're localized to ... language zero. It also emits a language-coded version block for 0x0409 (en-US). These two things cannot both be true. Collapse the wave function by hardcoding 0x0409.
microsoft · Apr 9, 2020 · a099897 · a099897
1 parent 2d09dfd
commit a099897
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/.github/actions/spell-check/dictionary/apis.txt b/.github/actions/spell-check/dictionary/apis.txt
@@ -1 +1,2 @@
+LCID
 rfind
diff --git a/src/cascadia/TerminalApp/AppLogic.cpp b/src/cascadia/TerminalApp/AppLogic.cpp
@@ -908,6 +908,39 @@ namespace winrt::TerminalApp::implementation
         }
         CATCH_LOG();
 
+        // Try to get the version the old-fashioned way
+        try
+        {
+            struct LocalizationInfo
+            {
+                WORD language, codepage;
+            };
+            // Use the current module instance handle for TerminalApp.dll, nullptr for WindowsTerminal.exe
+            auto filename{ wil::GetModuleFileNameW<std::wstring>(wil::GetModuleInstanceHandle()) };
+            auto size{ GetFileVersionInfoSizeExW(0, filename.c_str(), nullptr) };
+            THROW_LAST_ERROR_IF(size == 0);
+            auto versionBuffer{ std::make_unique<std::byte[]>(size) };
+            THROW_IF_WIN32_BOOL_FALSE(GetFileVersionInfoExW(0, filename.c_str(), 0, size, versionBuffer.get()));
+
+            // Get the list of Version localizations
+            LocalizationInfo* pVarLocalization{ nullptr };
+            UINT varLen{ 0 };
+            THROW_IF_WIN32_BOOL_FALSE(VerQueryValueW(versionBuffer.get(), L"\\VarFileInfo\\Translation", reinterpret_cast<void**>(&pVarLocalization), &varLen));
+            THROW_HR_IF(E_UNEXPECTED, varLen < sizeof(*pVarLocalization)); // there must be at least one translation
+
+            // Get the product version from the localized version compartment
+            // We're using String/ProductVersion here because our build pipeline puts more rich information in it (like the branch name)
+            // than in the unlocalized numeric version fields.
+            WCHAR* pProductVersion{ nullptr };
+            UINT versionLen{ 0 };
+            const auto localizedVersionName{ wil::str_printf<std::wstring>(L"\\StringFileInfo\\%04x%04x\\ProductVersion",
+                                                                           pVarLocalization->language ? pVarLocalization->language : 0x0409, // well-known en-US LCID
+                                                                           pVarLocalization->codepage) };
+            THROW_IF_WIN32_BOOL_FALSE(VerQueryValueW(versionBuffer.get(), localizedVersionName.c_str(), reinterpret_cast<void**>(&pProductVersion), &versionLen));
+            return { pProductVersion };
+        }
+        CATCH_LOG();
+
         return RS_(L"ApplicationVersionUnknown");
     }