Added TypeLibHelper.h/cpp which have utility functions for configuring Windows Registry for TypeLib com libraries.

Author: end2endzone

src/shellextension/CMakeLists.txt

@@ -20,6 +20,8 @@ add_library(sa.shellextension SHARED
   stdafx.cpp
   stdafx.h
   targetver.h
+  TypeLibHelper.cpp
+  TypeLibHelper.h
   utils.cpp
   utils.h
 )

src/shellextension/TypeLibHelper.cpp

@@ -0,0 +1,139 @@
+#include "stdafx.h"
+#include "TypeLibHelper.h"
+
+#include <strsafe.h> // for StringCchPrintf()
+
+using namespace ATL;
+extern HRESULT GetHKCRRegistryKeyAndValue(PCWSTR pszSubKey, PCWSTR pszValueName, PWSTR pszData, DWORD cbData);	// from Reg.cpp
+
+HRESULT GetTypeLibGuid(_In_ HINSTANCE hInstTypeLib, _In_opt_z_ LPCOLESTR lpszIndex, GUID& guid)
+{
+	ZeroMemory(&guid, sizeof(GUID));
+	TLIBATTR sTLibAttr;
+	HRESULT hr = GetTypeLibAttribute(hInstTypeLib, lpszIndex, &sTLibAttr);
+	if ( SUCCEEDED(hr) )
+		guid = sTLibAttr.guid;
+	return hr;
+}
+
+HRESULT GetTypeLibAttribute(_In_ HINSTANCE hInstTypeLib, _In_opt_z_ LPCOLESTR lpszIndex, _Out_ LPTLIBATTR pTLibAttr)
+{
+	if ( NULL == pTLibAttr )
+		return E_INVALIDARG;
+
+	ZeroMemory(pTLibAttr, sizeof(TLIBATTR));
+
+	CComBSTR bstrPath;
+	CComPtr<ITypeLib> pTypeLib;
+	HRESULT hr = AtlLoadTypeLib(hInstTypeLib, lpszIndex, &bstrPath, &pTypeLib);
+	if ( SUCCEEDED(hr) )
+	{
+		TLIBATTR* ptla;
+		hr = pTypeLib->GetLibAttr(&ptla);
+		if ( SUCCEEDED(hr) )
+		{
+			*pTLibAttr = *ptla;
+
+			pTypeLib->ReleaseTLibAttr(ptla);
+		}
+	}
+	return hr;
+}
+
+HRESULT IsTypeLibRegisteredOnSystem(const GUID& guid, PCWSTR szVersion)
+{
+	TLIBATTR sTLibAttr;
+	ZeroMemory(&sTLibAttr, sizeof(TLIBATTR));
+	sTLibAttr.guid = guid;
+	sTLibAttr.syskind = SYS_WIN64;
+	sTLibAttr.wMajorVerNum = 1;
+	sTLibAttr.wMinorVerNum = 0;
+
+	HRESULT hr = IsTypeLibRegisteredOnSystem(&sTLibAttr);
+	return hr;
+}
+
+HRESULT IsTypeLibRegisteredOnSystem(_In_ LPTLIBATTR pTLibAttr)
+{
+	if ( NULL == pTLibAttr )
+		return E_INVALIDARG;
+
+	HRESULT hr;
+
+	// guid to string
+  wchar_t szGUID[64] = { 0 };
+	StringFromGUID2(pTLibAttr->guid, szGUID, 64);
+
+	// version to string
+	wchar_t szVersion[32] = { 0 };
+	hr = StringCchPrintf(szVersion, ARRAYSIZE(szVersion), L"%d.%d", pTLibAttr->wMajorVerNum, pTLibAttr->wMajorVerNum);
+	if ( FAILED(hr) )
+		return hr;
+
+	// syskind to string
+	const wchar_t * szSysKind = NULL;
+	switch ( pTLibAttr->syskind )
+	{
+	//case SYS_WIN32: // not supported
+	case SYS_WIN64:
+		szSysKind = L"win64";
+		break;
+	default:
+		return HRESULT_FROM_WIN32(ERROR_INVALID_FLAGS);
+	};
+
+	// Check for the "HKCR\TypeLib\{guid}\{version}" key.
+	wchar_t szSubkey[MAX_PATH];
+	hr = StringCchPrintf(szSubkey, ARRAYSIZE(szSubkey), L"TypeLib\\%s\\%s", szGUID, szVersion);
+	if ( FAILED(hr) )
+		return hr;
+
+	// Get the TypeLib name
+	wchar_t szTypeLibName[MAX_PATH];
+	hr = GetHKCRRegistryKeyAndValue(szSubkey, nullptr, szTypeLibName, sizeof(szTypeLibName));
+	if ( FAILED(hr) )
+	{
+		if ( hr == HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND) )
+			return S_FALSE;
+		return hr; // unexpected error
+	}
+
+	// If TypeLib name is empty.
+	if ( szTypeLibName[0] == L'\0' )
+		return S_FALSE;
+
+	// Check for the "HKCR\TypeLib\{guid}\{version}\0\{syskind}" key.
+	hr = StringCchPrintf(szSubkey, ARRAYSIZE(szSubkey), L"TypeLib\\%s\\%s\\0\\%s", szGUID, szVersion, szSysKind);
+	if ( FAILED(hr) )
+		return hr;
+
+	// Get the TypeLib dll path
+	wchar_t szDllPath[MAX_PATH];
+	hr = GetHKCRRegistryKeyAndValue(szSubkey, nullptr, szDllPath, sizeof(szDllPath));
+	if ( FAILED(hr) )
+	{
+		if ( hr == HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND) )
+			return S_FALSE;
+		return hr; // unexpected error
+	}
+
+	// If TypeLib dll path is empty.
+	if ( szDllPath[0] == L'\0' )
+		return S_FALSE;
+
+	//// Get path to current module
+	//wchar_t szModule[MAX_PATH];
+	//HINSTANCE hInst = GetModuleHandle(NULL);
+	//hr = S_OK;
+	//if ( GetModuleFileName(hInst, szModule, ARRAYSIZE(szModule)) == 0 )
+	//{
+	//	hr = HRESULT_FROM_WIN32(GetLastError());
+	//	return hr;
+	//}
+
+	//// If TypeLib dll path is not this module's path.
+	//if ( _wcsicmp(szDllPath, szModule) == 0)
+	//	return S_FALSE;
+
+	return S_OK;
+}

src/shellextension/TypeLibHelper.h

@@ -0,0 +1,50 @@
+#pragma once
+
+#include <Windows.h>
+
+/// <summary>
+/// Get the GUID of the TypeLib at index lpszIndex within this module.
+/// </summary>
+/// <param name="hInstTypeLib">A reference to the module that contains the TypeLib.</param>
+/// <param name="lpszIndex">The index of the TyleLib within this module.</param>
+/// <param name="guid">The output guid value of the typelib at given index.</param>
+/// <returns>Returns S_OK if the attributes of the requested typelib is found. Returns an HRESULT matching an error code otherwise.</returns>
+HRESULT GetTypeLibGuid(_In_ HINSTANCE hInstTypeLib, _In_opt_z_ LPCOLESTR lpszIndex, GUID& guid);
+
+/// <summary>
+/// Get the attributes of the TypeLib at index lpszIndex within this module.
+/// </summary>
+/// <param name="hInstTypeLib">A reference to the module that contains the TypeLib.</param>
+/// <param name="lpszIndex">The index of the queries TypeLib within the instance.</param>
+/// <param name="libattr">A pointer to the output library attributes</param>
+/// <returns>Returns S_OK if the attributes of the requested typelib is found. Returns an HRESULT matching an error code otherwise.</returns>
+HRESULT GetTypeLibAttribute(_In_ HINSTANCE hInstTypeLib, _In_opt_z_ LPCOLESTR lpszIndex, _Out_ LPTLIBATTR pTLibAttr);
+
+/// <summary>
+/// Check if the given typelib guid is registered on system.
+/// </summary>
+/// <remarks>
+/// The following registry keys and values are present for a registered typelib:
+///   [HKEY_CLASSES_ROOT\TypeLib\{guid}\1.0]
+///   @ = "MyClassNameLib"
+///   [HKEY_CLASSES_ROOT\TypeLib\{guid}\1.0\0\win64]
+///   @ = "Z:\\path\\to\\current\\file.dll"
+/// </remarks>
+/// <param name="guid">The typelib's guid value.</param>
+/// <param name="guid">The typelib version value. Usually "1.0".</param>
+/// <returns>Returns S_OK if the typelib is registered on system. Returns S_FALSE if the typelib is not registered on system. Returns an HRESULT matching an error code otherwise.</returns>
+HRESULT IsTypeLibRegisteredOnSystem(const GUID& guid, PCWSTR szVersion);
+
+/// <summary>
+/// Check if the given typelib is registered on system.
+/// </summary>
+/// <remarks>
+/// The following registry keys and values are present for a registered typelib:
+///   [HKEY_CLASSES_ROOT\TypeLib\{guid}\{version}]
+///   @ = "MyClassNameLib"
+///   [HKEY_CLASSES_ROOT\TypeLib\{guid}\{version}\0\win64]
+///   @ = "Z:\\path\\to\\current\\file.dll"
+/// </remarks>
+/// <param name="pTLibAttr">A pointer to the typelib's attributes.</param>
+/// <returns>Returns S_OK if the typelib is registered on system. Returns S_FALSE if the typelib is not registered on system. Returns an HRESULT matching an error code otherwise.</returns>
+HRESULT IsTypeLibRegisteredOnSystem(_In_ LPTLIBATTR pTLibAttr);