Merge pull request #54 from Microsoft/develop

heaths · web-flow · commit 8619e9697f4e · 2017-04-10T15:12:00.000-07:00
Print query API version in logo
diff --git a/src/vswhere.lib/resource.h b/src/vswhere.lib/resource.h
diff --git a/src/vswhere.lib/vswhere.lib.rc b/src/vswhere.lib/vswhere.lib.rc
diff --git a/src/vswhere/Module.cpp b/src/vswhere/Module.cpp
@@ -0,0 +1,87 @@
+// <copyright file="Module.cpp" company="Microsoft Corporation">
+// Copyright (C) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE.txt in the project root for license information.
+// </copyright>
+
+#include "stdafx.h"
+
+using namespace std;
+
+void Module::FromIUnknown(_In_ const IUnknown* pUnk) noexcept
+{
+    typedef struct IUnknownVtbl
+    {
+        HRESULT(STDMETHODCALLTYPE *QueryInterface)(ISetupConfiguration*, REFIID, LPVOID*);
+        ULONG(STDMETHODCALLTYPE *AddRef)(ISetupConfiguration*);
+        ULONG(STDMETHODCALLTYPE *Release)(ISetupConfiguration*);
+    } IUnknownVtbl;
+
+    auto pVtbl = reinterpret_cast<const IUnknownVtbl*>(pUnk);
+    ::GetModuleHandleExW(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS, reinterpret_cast<LPCWSTR>(pVtbl->QueryInterface), &m_hModule);
+}
+
+const wstring& Module::get_Path() noexcept
+{
+    if (m_hModule && m_path.empty())
+    {
+        m_path.resize(MAX_PATH);
+        ::GetModuleFileNameW(m_hModule, const_cast<LPWSTR>(m_path.data()), m_path.size());
+    }
+
+    return m_path;
+}
+
+const wstring& Module::get_FileVersion() noexcept
+{
+    auto path = get_Path();
+    if (path.empty())
+    {
+        return m_fileVersion;
+    }
+
+    DWORD dwHandle = 0;
+    DWORD cbVersionInfo = ::GetFileVersionInfoSizeW(path.c_str(), &dwHandle);
+    if (!cbVersionInfo)
+    {
+        return m_fileVersion;
+    }
+
+    vector<byte> buffer(cbVersionInfo);
+    if (!::GetFileVersionInfoW(path.c_str(), dwHandle, buffer.size(), buffer.data()))
+    {
+        return m_fileVersion;
+    }
+
+    VS_FIXEDFILEINFO* pFileInfo = NULL;
+    UINT cbFileInfo = 0;
+    if (!::VerQueryValueW(buffer.data(), L"\\", reinterpret_cast<LPVOID*>(&pFileInfo), &cbFileInfo))
+    {
+        return m_fileVersion;
+    }
+
+    auto cch = _scwprintf(
+        L"%d.%d.%d.%d",
+        (pFileInfo->dwFileVersionMS >> 16) & 0xffff,
+        pFileInfo->dwFileVersionMS & 0xffff,
+        (pFileInfo->dwFileVersionLS >> 16) & 0xffff,
+        pFileInfo->dwFileVersionLS & 0xffff);
+    if (!cch)
+    {
+        return m_fileVersion;
+    }
+
+    m_fileVersion.resize(++cch);
+    swprintf_s(
+        const_cast<LPWSTR>(m_fileVersion.c_str()),
+        m_fileVersion.size(),
+        L"%d.%d.%d.%d",
+        (pFileInfo->dwFileVersionMS >> 16) & 0xffff,
+        pFileInfo->dwFileVersionMS & 0xffff,
+        (pFileInfo->dwFileVersionLS >> 16) & 0xffff,
+        pFileInfo->dwFileVersionLS & 0xffff);
+
+    // Trim terminating null character.
+    m_fileVersion.resize(--cch);
+
+    return m_fileVersion;
+}
diff --git a/src/vswhere/Module.h b/src/vswhere/Module.h
@@ -0,0 +1,40 @@
+// <copyright file="Module.h" company="Microsoft Corporation">
+// Copyright (C) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE.txt in the project root for license information.
+// </copyright>
+
+#pragma once
+
+class Module
+{
+public:
+    Module() :
+        m_hModule(NULL)
+    {
+    }
+
+    Module(_In_ const Module& obj) :
+        m_hModule(obj.m_hModule),
+        m_path(obj.m_path),
+        m_fileVersion(obj.m_fileVersion)
+    {
+    }
+
+    ~Module()
+    {
+        if (m_hModule)
+        {
+            ::FreeLibrary(m_hModule);
+        }
+    }
+
+    // Avoid throwing non-catastrphic exceptions since information is for diagnostics only.
+    void FromIUnknown(_In_ const IUnknown* pUnk) noexcept;
+    const std::wstring& get_Path() noexcept;
+    const std::wstring& get_FileVersion() noexcept;
+
+private:
+    HMODULE m_hModule;
+    std::wstring m_path;
+    std::wstring m_fileVersion;
+};
diff --git a/src/vswhere/Program.cpp b/src/vswhere/Program.cpp
@@ -8,12 +8,13 @@
 using namespace std;
 
 void GetEnumerator(_In_ const CommandArgs& args, _In_ ISetupConfigurationPtr& query, _In_ IEnumSetupInstancesPtr& e);
-void WriteLogo(_In_ const CommandArgs& args, _In_ Console& console);
+void WriteLogo(_In_ const CommandArgs& args, _In_ Console& console, _In_ Module& module);
 
 int wmain(_In_ int argc, _In_ LPCWSTR argv[])
 {
     CommandArgs args;
     Console console(args);
+    Module queryModule;
 
     console.Initialize();
     try
@@ -23,7 +24,7 @@ int wmain(_In_ int argc, _In_ LPCWSTR argv[])
         args.Parse(argc, argv);
         if (args.get_Help())
         {
-            WriteLogo(args, console);
+            WriteLogo(args, console, queryModule);
             args.Usage(console);
 
             return ERROR_SUCCESS;
@@ -34,6 +35,9 @@ int wmain(_In_ int argc, _In_ LPCWSTR argv[])
 
         GetEnumerator(args, query, e);
 
+        // Try to get information about the query module for later.
+        queryModule.FromIUnknown(static_cast<IUnknown*>(query));
+
         // Attempt to get the ISetupHelper.
         ISetupHelperPtr helper;
         if (query)
@@ -48,7 +52,7 @@ int wmain(_In_ int argc, _In_ LPCWSTR argv[])
         auto formatter = Formatter::Create(args.get_Format());
         if (formatter->ShowLogo())
         {
-            WriteLogo(args, console);
+            WriteLogo(args, console, queryModule);
         }
 
         formatter->Write(args, console, instances);
@@ -59,7 +63,7 @@ int wmain(_In_ int argc, _In_ LPCWSTR argv[])
         const auto code = ex.code().value();
         if (ERROR_INVALID_PARAMETER == code)
         {
-            WriteLogo(args, console);
+            WriteLogo(args, console, queryModule);
         }
 
         console.Write(L"%ls 0x%x: ", ResourceManager::GetString(IDS_ERROR).c_str(), code);
@@ -127,11 +131,14 @@ void GetEnumerator(_In_ const CommandArgs& args, _In_ ISetupConfigurationPtr& qu
     }
 }
 
-void WriteLogo(_In_ const CommandArgs& args, _In_ Console& console)
+void WriteLogo(_In_ const CommandArgs& args, _In_ Console& console, _In_ Module& module)
 {
     if (args.get_Logo())
     {
-        console.WriteLine(ResourceManager::FormatString(IDS_PROGRAMINFO, FILE_VERSION_STRINGW));
+        const auto version = module.get_FileVersion();
+        const auto nID = version.empty() ? IDS_PROGRAMINFO : IDS_PROGRAMINFOEX;
+
+        console.WriteLine(ResourceManager::FormatString(nID, FILE_VERSION_STRINGW, version.c_str()));
         console.WriteLine(ResourceManager::GetString(IDS_COPYRIGHT));
         console.WriteLine();
     }
diff --git a/src/vswhere/stdafx.h b/src/vswhere/stdafx.h
@@ -18,6 +18,7 @@
 // Project headers
 #include <stdafx.h>
 #include <VersionInfo.h>
+#include "Module.h"
 
 _COM_SMARTPTR_TYPEDEF(ISetupConfiguration, __uuidof(ISetupConfiguration));
 _COM_SMARTPTR_TYPEDEF(ISetupConfiguration2, __uuidof(ISetupConfiguration2));
diff --git a/src/vswhere/vswhere.vcxproj b/src/vswhere/vswhere.vcxproj
@@ -63,6 +63,7 @@
     <Link>
       <SubSystem>Console</SubSystem>
       <GenerateDebugInformation>true</GenerateDebugInformation>
+      <AdditionalDependencies>version.lib;%(AdditionalDependencies)</AdditionalDependencies>
     </Link>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
@@ -81,14 +82,17 @@
       <EnableCOMDATFolding>true</EnableCOMDATFolding>
       <OptimizeReferences>true</OptimizeReferences>
       <GenerateDebugInformation>true</GenerateDebugInformation>
+      <AdditionalDependencies>version.lib;%(AdditionalDependencies)</AdditionalDependencies>
     </Link>
   </ItemDefinitionGroup>
   <ItemGroup>
+    <ClInclude Include="Module.h" />
     <ClInclude Include="resource.h" />
     <ClInclude Include="stdafx.h" />
     <ClInclude Include="targetver.h" />
   </ItemGroup>
   <ItemGroup>
+    <ClCompile Include="Module.cpp" />
     <ClCompile Include="Program.cpp" />
     <ClCompile Include="stdafx.cpp">
       <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">Create</PrecompiledHeader>
diff --git a/src/vswhere/vswhere.vcxproj.filters b/src/vswhere/vswhere.vcxproj.filters
@@ -24,6 +24,9 @@
     <ClInclude Include="resource.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="Module.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="stdafx.cpp">
@@ -32,6 +35,9 @@
     <ClCompile Include="Program.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="Module.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="packages.config" />

Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,13 @@`
`8`	`8`	`using namespace std;`
`9`	`9`
`10`	`10`	`void GetEnumerator(_In_ const CommandArgs& args, _In_ ISetupConfigurationPtr& query, _In_ IEnumSetupInstancesPtr& e);`
`11`		`-void WriteLogo(_In_ const CommandArgs& args, _In_ Console& console);`
	`11`	`+void WriteLogo(_In_ const CommandArgs& args, _In_ Console& console, _In_ Module& module);`
`12`	`12`
`13`	`13`	`int wmain(_In_ int argc, _In_ LPCWSTR argv[])`
`14`	`14`	`{`
`15`	`15`	`CommandArgs args;`
`16`	`16`	`Console console(args);`
	`17`	`+ Module queryModule;`
`17`	`18`
`18`	`19`	`console.Initialize();`
`19`	`20`	`try`
`@@ -23,7 +24,7 @@ int wmain(_In_ int argc, _In_ LPCWSTR argv[])`
`23`	`24`	`args.Parse(argc, argv);`
`24`	`25`	`if (args.get_Help())`
`25`	`26`	`{`
`26`		`- WriteLogo(args, console);`
	`27`	`+ WriteLogo(args, console, queryModule);`
`27`	`28`	`args.Usage(console);`
`28`	`29`
`29`	`30`	`return ERROR_SUCCESS;`
`@@ -34,6 +35,9 @@ int wmain(_In_ int argc, _In_ LPCWSTR argv[])`
`34`	`35`
`35`	`36`	`GetEnumerator(args, query, e);`
`36`	`37`
	`38`	`+ // Try to get information about the query module for later.`
	`39`	`+ queryModule.FromIUnknown(static_cast<IUnknown*>(query));`
	`40`	`+`
`37`	`41`	`// Attempt to get the ISetupHelper.`
`38`	`42`	`ISetupHelperPtr helper;`
`39`	`43`	`if (query)`
`@@ -48,7 +52,7 @@ int wmain(_In_ int argc, _In_ LPCWSTR argv[])`
`48`	`52`	`auto formatter = Formatter::Create(args.get_Format());`
`49`	`53`	`if (formatter->ShowLogo())`
`50`	`54`	`{`
`51`		`- WriteLogo(args, console);`
	`55`	`+ WriteLogo(args, console, queryModule);`
`52`	`56`	`}`
`53`	`57`
`54`	`58`	`formatter->Write(args, console, instances);`
`@@ -59,7 +63,7 @@ int wmain(_In_ int argc, _In_ LPCWSTR argv[])`
`59`	`63`	`const auto code = ex.code().value();`
`60`	`64`	`if (ERROR_INVALID_PARAMETER == code)`
`61`	`65`	`{`
`62`		`- WriteLogo(args, console);`
	`66`	`+ WriteLogo(args, console, queryModule);`
`63`	`67`	`}`
`64`	`68`
`65`	`69`	`console.Write(L"%ls 0x%x: ", ResourceManager::GetString(IDS_ERROR).c_str(), code);`
`@@ -127,11 +131,14 @@ void GetEnumerator(_In_ const CommandArgs& args, _In_ ISetupConfigurationPtr& qu`
`127`	`131`	`}`
`128`	`132`	`}`
`129`	`133`
`130`		`-void WriteLogo(_In_ const CommandArgs& args, _In_ Console& console)`
	`134`	`+void WriteLogo(_In_ const CommandArgs& args, _In_ Console& console, _In_ Module& module)`
`131`	`135`	`{`
`132`	`136`	`if (args.get_Logo())`
`133`	`137`	`{`
`134`		`- console.WriteLine(ResourceManager::FormatString(IDS_PROGRAMINFO, FILE_VERSION_STRINGW));`
	`138`	`+ const auto version = module.get_FileVersion();`
	`139`	`+ const auto nID = version.empty() ? IDS_PROGRAMINFO : IDS_PROGRAMINFOEX;`
	`140`	`+`
	`141`	`+ console.WriteLine(ResourceManager::FormatString(nID, FILE_VERSION_STRINGW, version.c_str()));`
`135`	`142`	`console.WriteLine(ResourceManager::GetString(IDS_COPYRIGHT));`
`136`	`143`	`console.WriteLine();`
`137`	`144`	`}`