Blame libfreerdp/common/addin.c

Packit Service fa4841
/**
Packit Service fa4841
 * FreeRDP: A Remote Desktop Protocol Implementation
Packit Service fa4841
 * Addin Loader
Packit Service fa4841
 *
Packit Service fa4841
 * Copyright 2012 Marc-Andre Moreau <marcandre.moreau@gmail.com>
Packit Service fa4841
 *
Packit Service fa4841
 * Licensed under the Apache License, Version 2.0 (the "License");
Packit Service fa4841
 * you may not use this file except in compliance with the License.
Packit Service fa4841
 * You may obtain a copy of the License at
Packit Service fa4841
 *
Packit Service fa4841
 *     http://www.apache.org/licenses/LICENSE-2.0
Packit Service fa4841
 *
Packit Service fa4841
 * Unless required by applicable law or agreed to in writing, software
Packit Service fa4841
 * distributed under the License is distributed on an "AS IS" BASIS,
Packit Service fa4841
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Packit Service fa4841
 * See the License for the specific language governing permissions and
Packit Service fa4841
 * limitations under the License.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
#ifdef HAVE_CONFIG_H
Packit Service fa4841
#include "config.h"
Packit Service fa4841
#endif
Packit Service fa4841
Packit Service fa4841
#include <stdio.h>
Packit Service fa4841
#include <stdlib.h>
Packit Service fa4841
#include <string.h>
Packit Service fa4841
Packit Service fa4841
#include <winpr/crt.h>
Packit Service fa4841
#include <winpr/path.h>
Packit Service fa4841
#include <winpr/string.h>
Packit Service fa4841
#include <winpr/library.h>
Packit Service fa4841
Packit Service fa4841
#include <freerdp/addin.h>
Packit Service fa4841
#include <freerdp/build-config.h>
Packit Service fa4841
Packit Service fa4841
#include <freerdp/log.h>
Packit Service fa4841
#define TAG FREERDP_TAG("addin")
Packit Service fa4841
Packit Service fa4841
static INLINE BOOL is_path_required(LPCSTR path, size_t len)
Packit Service fa4841
{
Packit Service fa4841
	if (!path || (len <= 1))
Packit Service fa4841
		return FALSE;
Packit Service fa4841
Packit Service fa4841
	if (strcmp(path, ".") == 0)
Packit Service fa4841
		return FALSE;
Packit Service fa4841
Packit Service fa4841
	return TRUE;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
LPSTR freerdp_get_library_install_path(void)
Packit Service fa4841
{
Packit Service fa4841
	LPSTR pszPath;
Packit Service fa4841
	size_t cchPath;
Packit Service fa4841
	size_t cchLibraryPath;
Packit Service fa4841
	size_t cchInstallPrefix;
Packit Service fa4841
	BOOL needLibPath, needInstallPath;
Packit Service fa4841
	LPCSTR pszLibraryPath = FREERDP_LIBRARY_PATH;
Packit Service fa4841
	LPCSTR pszInstallPrefix = FREERDP_INSTALL_PREFIX;
Packit Service fa4841
	cchLibraryPath = strlen(pszLibraryPath) + 1;
Packit Service fa4841
	cchInstallPrefix = strlen(pszInstallPrefix) + 1;
Packit Service fa4841
	cchPath = cchInstallPrefix + cchLibraryPath;
Packit Service fa4841
	needInstallPath = is_path_required(pszInstallPrefix, cchInstallPrefix);
Packit Service fa4841
	needLibPath = is_path_required(pszLibraryPath, cchLibraryPath);
Packit Service fa4841
Packit Service fa4841
	if (!needInstallPath && !needLibPath)
Packit Service fa4841
		return NULL;
Packit Service fa4841
Packit Service b1ea74
	pszPath = (LPSTR)malloc(cchPath + 1);
Packit Service fa4841
Packit Service fa4841
	if (!pszPath)
Packit Service fa4841
		return NULL;
Packit Service fa4841
Packit Service fa4841
	if (needInstallPath)
Packit Service fa4841
	{
Packit Service fa4841
		CopyMemory(pszPath, pszInstallPrefix, cchInstallPrefix);
Packit Service fa4841
		pszPath[cchInstallPrefix] = '\0';
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	if (needLibPath)
Packit Service fa4841
	{
Packit Service fa4841
		if (FAILED(NativePathCchAppendA(pszPath, cchPath + 1, pszLibraryPath)))
Packit Service fa4841
		{
Packit Service fa4841
			free(pszPath);
Packit Service fa4841
			return NULL;
Packit Service fa4841
		}
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	return pszPath;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
LPSTR freerdp_get_dynamic_addin_install_path(void)
Packit Service fa4841
{
Packit Service fa4841
	LPSTR pszPath;
Packit Service fa4841
	size_t cchPath;
Packit Service fa4841
	size_t cchAddinPath;
Packit Service fa4841
	size_t cchInstallPrefix;
Packit Service fa4841
	BOOL needLibPath, needInstallPath;
Packit Service fa4841
	LPCSTR pszAddinPath = FREERDP_ADDIN_PATH;
Packit Service fa4841
	LPCSTR pszInstallPrefix = FREERDP_INSTALL_PREFIX;
Packit Service fa4841
	cchAddinPath = strlen(pszAddinPath) + 1;
Packit Service fa4841
	cchInstallPrefix = strlen(pszInstallPrefix) + 1;
Packit Service fa4841
	cchPath = cchInstallPrefix + cchAddinPath;
Packit Service fa4841
	needInstallPath = is_path_required(pszInstallPrefix, cchInstallPrefix);
Packit Service fa4841
	needLibPath = is_path_required(pszAddinPath, cchAddinPath);
Packit Service fa4841
Packit Service fa4841
	if (!needInstallPath && !needLibPath)
Packit Service fa4841
		return NULL;
Packit Service fa4841
Packit Service b1ea74
	pszPath = (LPSTR)calloc(cchPath + 1, sizeof(CHAR));
Packit Service fa4841
Packit Service fa4841
	if (!pszPath)
Packit Service fa4841
		return NULL;
Packit Service fa4841
Packit Service fa4841
	if (needInstallPath)
Packit Service fa4841
	{
Packit Service fa4841
		CopyMemory(pszPath, pszInstallPrefix, cchInstallPrefix);
Packit Service fa4841
		pszPath[cchInstallPrefix] = '\0';
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	if (needLibPath)
Packit Service fa4841
	{
Packit Service fa4841
		if (FAILED(NativePathCchAppendA(pszPath, cchPath + 1, pszAddinPath)))
Packit Service fa4841
		{
Packit Service fa4841
			free(pszPath);
Packit Service fa4841
			return NULL;
Packit Service fa4841
		}
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	return pszPath;
Packit Service fa4841
}
Packit Service fa4841
Packit Service b1ea74
PVIRTUALCHANNELENTRY freerdp_load_dynamic_addin(LPCSTR pszFileName, LPCSTR pszPath,
Packit Service b1ea74
                                                LPCSTR pszEntryName)
Packit Service fa4841
{
Packit Service fa4841
	LPSTR pszAddinInstallPath = freerdp_get_dynamic_addin_install_path();
Packit Service fa4841
	PVIRTUALCHANNELENTRY entry = NULL;
Packit Service fa4841
	BOOL bHasExt = TRUE;
Packit Service fa4841
	PCSTR pszExt;
Packit Service fa4841
	size_t cchExt = 0;
Packit Service fa4841
	HINSTANCE library = NULL;
Packit Service fa4841
	size_t cchFileName;
Packit Service fa4841
	size_t cchFilePath;
Packit Service fa4841
	LPSTR pszAddinFile = NULL;
Packit Service fa4841
	LPSTR pszFilePath = NULL;
Packit Service fa4841
	LPSTR pszRelativeFilePath = NULL;
Packit Service fa4841
	size_t cchAddinFile;
Packit Service fa4841
	size_t cchAddinInstallPath;
Packit Service fa4841
Packit Service fa4841
	if (!pszFileName || !pszEntryName)
Packit Service fa4841
		goto fail;
Packit Service fa4841
Packit Service fa4841
	cchFileName = strlen(pszFileName);
Packit Service fa4841
Packit Service fa4841
	/* Get file name with prefix and extension */
Packit Service fa4841
	if (FAILED(PathCchFindExtensionA(pszFileName, cchFileName + 1, &pszExt)))
Packit Service fa4841
	{
Packit Service fa4841
		pszExt = PathGetSharedLibraryExtensionA(PATH_SHARED_LIB_EXT_WITH_DOT);
Packit Service fa4841
		cchExt = strlen(pszExt);
Packit Service fa4841
		bHasExt = FALSE;
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	if (bHasExt)
Packit Service fa4841
	{
Packit Service fa4841
		pszAddinFile = _strdup(pszFileName);
Packit Service fa4841
Packit Service fa4841
		if (!pszAddinFile)
Packit Service fa4841
			goto fail;
Packit Service fa4841
	}
Packit Service fa4841
	else
Packit Service fa4841
	{
Packit Service fa4841
		cchAddinFile = cchFileName + cchExt + 2 + sizeof(FREERDP_SHARED_LIBRARY_PREFIX);
Packit Service b1ea74
		pszAddinFile = (LPSTR)malloc(cchAddinFile + 1);
Packit Service fa4841
Packit Service fa4841
		if (!pszAddinFile)
Packit Service fa4841
			goto fail;
Packit Service fa4841
Packit Service b1ea74
		sprintf_s(pszAddinFile, cchAddinFile, FREERDP_SHARED_LIBRARY_PREFIX "%s%s", pszFileName,
Packit Service b1ea74
		          pszExt);
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	cchAddinFile = strlen(pszAddinFile);
Packit Service fa4841
Packit Service fa4841
	/* If a path is provided prefix the library name with it. */
Packit Service fa4841
	if (pszPath)
Packit Service fa4841
	{
Packit Service fa4841
		size_t relPathLen = strlen(pszPath) + cchAddinFile + 1;
Packit Service fa4841
		pszRelativeFilePath = calloc(relPathLen, sizeof(CHAR));
Packit Service fa4841
Packit Service fa4841
		if (!pszRelativeFilePath)
Packit Service fa4841
			goto fail;
Packit Service fa4841
Packit Service fa4841
		sprintf_s(pszRelativeFilePath, relPathLen, "%s", pszPath);
Packit Service fa4841
		NativePathCchAppendA(pszRelativeFilePath, relPathLen, pszAddinFile);
Packit Service fa4841
	}
Packit Service fa4841
	else
Packit Service fa4841
		pszRelativeFilePath = _strdup(pszAddinFile);
Packit Service fa4841
Packit Service fa4841
	if (!pszRelativeFilePath)
Packit Service fa4841
		goto fail;
Packit Service fa4841
Packit Service fa4841
	/* If a system prefix path is provided try these locations too. */
Packit Service fa4841
	if (pszAddinInstallPath)
Packit Service fa4841
	{
Packit Service fa4841
		cchAddinInstallPath = strlen(pszAddinInstallPath);
Packit Service fa4841
		cchFilePath = cchAddinInstallPath + cchFileName + 32;
Packit Service b1ea74
		pszFilePath = (LPSTR)malloc(cchFilePath + 1);
Packit Service fa4841
Packit Service fa4841
		if (!pszFilePath)
Packit Service fa4841
			goto fail;
Packit Service fa4841
Packit Service fa4841
		CopyMemory(pszFilePath, pszAddinInstallPath, cchAddinInstallPath);
Packit Service fa4841
		pszFilePath[cchAddinInstallPath] = '\0';
Packit Service b1ea74
		NativePathCchAppendA((LPSTR)pszFilePath, cchFilePath + 1, pszRelativeFilePath);
Packit Service fa4841
	}
Packit Service fa4841
	else
Packit Service fa4841
		pszFilePath = _strdup(pszRelativeFilePath);
Packit Service fa4841
Packit Service fa4841
	library = LoadLibraryA(pszFilePath);
Packit Service fa4841
Packit Service fa4841
	if (!library)
Packit Service fa4841
		goto fail;
Packit Service fa4841
Packit Service fa4841
	entry = (PVIRTUALCHANNELENTRY)GetProcAddress(library, pszEntryName);
Packit Service fa4841
fail:
Packit Service fa4841
	free(pszRelativeFilePath);
Packit Service fa4841
	free(pszAddinFile);
Packit Service fa4841
	free(pszFilePath);
Packit Service fa4841
	free(pszAddinInstallPath);
Packit Service fa4841
Packit Service fa4841
	if (!entry && library)
Packit Service fa4841
		FreeLibrary(library);
Packit Service fa4841
Packit Service fa4841
	return entry;
Packit Service fa4841
}
Packit Service fa4841
Packit Service b1ea74
PVIRTUALCHANNELENTRY freerdp_load_dynamic_channel_addin_entry(LPCSTR pszName, LPCSTR pszSubsystem,
Packit Service b1ea74
                                                              LPCSTR pszType, DWORD dwFlags)
Packit Service fa4841
{
Packit Service fa4841
	PVIRTUALCHANNELENTRY entry;
Packit Service fa4841
	LPSTR pszFileName;
Packit Service fa4841
	const size_t cchBaseFileName = sizeof(FREERDP_SHARED_LIBRARY_PREFIX) + 32;
Packit Service fa4841
	LPCSTR pszExtension;
Packit Service fa4841
	LPCSTR pszPrefix = FREERDP_SHARED_LIBRARY_PREFIX;
Packit Service b1ea74
	size_t nameLen = 0;
Packit Service b1ea74
	size_t subsystemLen = 0;
Packit Service b1ea74
	size_t typeLen = 0;
Packit Service b1ea74
	size_t extensionLen = 0;
Packit Service fa4841
	pszExtension = PathGetSharedLibraryExtensionA(0);
Packit Service b1ea74
	if (pszName)
Packit Service b1ea74
		nameLen = strnlen(pszName, MAX_PATH);
Packit Service b1ea74
	if (pszSubsystem)
Packit Service b1ea74
		subsystemLen = strnlen(pszSubsystem, MAX_PATH);
Packit Service b1ea74
	if (pszType)
Packit Service b1ea74
		typeLen = strnlen(pszType, MAX_PATH);
Packit Service b1ea74
	if (pszExtension)
Packit Service b1ea74
		extensionLen = strnlen(pszExtension, MAX_PATH);
Packit Service fa4841
Packit Service fa4841
	if (pszName && pszSubsystem && pszType)
Packit Service fa4841
	{
Packit Service b1ea74
		const size_t cchFileName =
Packit Service b1ea74
		    cchBaseFileName + nameLen + subsystemLen + typeLen + extensionLen;
Packit Service b1ea74
		pszFileName = (LPSTR)malloc(cchFileName);
Packit Service fa4841
Packit Service fa4841
		if (!pszFileName)
Packit Service fa4841
			return NULL;
Packit Service fa4841
Packit Service fa4841
		sprintf_s(pszFileName, cchFileName, "%s%s-client-%s-%s.%s", pszPrefix, pszName,
Packit Service fa4841
		          pszSubsystem, pszType, pszExtension);
Packit Service fa4841
	}
Packit Service fa4841
	else if (pszName && pszSubsystem)
Packit Service fa4841
	{
Packit Service b1ea74
		const size_t cchFileName = cchBaseFileName + nameLen + subsystemLen + extensionLen;
Packit Service b1ea74
		pszFileName = (LPSTR)malloc(cchFileName);
Packit Service fa4841
Packit Service fa4841
		if (!pszFileName)
Packit Service fa4841
			return NULL;
Packit Service fa4841
Packit Service b1ea74
		sprintf_s(pszFileName, cchFileName, "%s%s-client-%s.%s", pszPrefix, pszName, pszSubsystem,
Packit Service b1ea74
		          pszExtension);
Packit Service fa4841
	}
Packit Service fa4841
	else if (pszName)
Packit Service fa4841
	{
Packit Service b1ea74
		const size_t cchFileName = cchBaseFileName + nameLen + extensionLen;
Packit Service b1ea74
		pszFileName = (LPSTR)malloc(cchFileName);
Packit Service fa4841
Packit Service fa4841
		if (!pszFileName)
Packit Service fa4841
			return NULL;
Packit Service fa4841
Packit Service b1ea74
		sprintf_s(pszFileName, cchFileName, "%s%s-client.%s", pszPrefix, pszName, pszExtension);
Packit Service fa4841
	}
Packit Service fa4841
	else
Packit Service fa4841
	{
Packit Service fa4841
		return NULL;
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	if (pszSubsystem)
Packit Service fa4841
	{
Packit Service fa4841
		LPSTR pszEntryName;
Packit Service fa4841
		size_t cchEntryName;
Packit Service fa4841
		/* subsystem add-in */
Packit Service b1ea74
		cchEntryName = 64 + nameLen;
Packit Service b1ea74
		pszEntryName = (LPSTR)malloc(cchEntryName + 1);
Packit Service fa4841
Packit Service fa4841
		if (!pszEntryName)
Packit Service fa4841
		{
Packit Service fa4841
			free(pszFileName);
Packit Service fa4841
			return NULL;
Packit Service fa4841
		}
Packit Service fa4841
Packit Service b1ea74
		sprintf_s(pszEntryName, cchEntryName + 1, "freerdp_%s_client_subsystem_entry", pszName);
Packit Service fa4841
		entry = freerdp_load_dynamic_addin(pszFileName, NULL, pszEntryName);
Packit Service fa4841
		free(pszEntryName);
Packit Service fa4841
		free(pszFileName);
Packit Service fa4841
		return entry;
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	/* channel add-in */
Packit Service fa4841
Packit Service fa4841
	if (dwFlags & FREERDP_ADDIN_CHANNEL_STATIC)
Packit Service fa4841
	{
Packit Service fa4841
		if (dwFlags & FREERDP_ADDIN_CHANNEL_ENTRYEX)
Packit Service fa4841
			entry = freerdp_load_dynamic_addin(pszFileName, NULL, "VirtualChannelEntryEx");
Packit Service fa4841
		else
Packit Service fa4841
			entry = freerdp_load_dynamic_addin(pszFileName, NULL, "VirtualChannelEntry");
Packit Service fa4841
	}
Packit Service fa4841
	else if (dwFlags & FREERDP_ADDIN_CHANNEL_DYNAMIC)
Packit Service fa4841
		entry = freerdp_load_dynamic_addin(pszFileName, NULL, "DVCPluginEntry");
Packit Service fa4841
	else if (dwFlags & FREERDP_ADDIN_CHANNEL_DEVICE)
Packit Service fa4841
		entry = freerdp_load_dynamic_addin(pszFileName, NULL, "DeviceServiceEntry");
Packit Service fa4841
	else
Packit Service fa4841
		entry = freerdp_load_dynamic_addin(pszFileName, NULL, pszType);
Packit Service fa4841
Packit Service fa4841
	free(pszFileName);
Packit Service fa4841
	return entry;
Packit Service fa4841
}
Packit Service fa4841
Packit Service b1ea74
static FREERDP_LOAD_CHANNEL_ADDIN_ENTRY_FN freerdp_load_static_channel_addin_entry = NULL;
Packit Service fa4841
Packit Service b1ea74
int freerdp_register_addin_provider(FREERDP_LOAD_CHANNEL_ADDIN_ENTRY_FN provider, DWORD dwFlags)
Packit Service fa4841
{
Packit Service fa4841
	freerdp_load_static_channel_addin_entry = provider;
Packit Service fa4841
	return 0;
Packit Service fa4841
}
Packit Service fa4841
Packit Service b1ea74
PVIRTUALCHANNELENTRY freerdp_load_channel_addin_entry(LPCSTR pszName, LPCSTR pszSubsystem,
Packit Service b1ea74
                                                      LPCSTR pszType, DWORD dwFlags)
Packit Service fa4841
{
Packit Service fa4841
	PVIRTUALCHANNELENTRY entry = NULL;
Packit Service fa4841
Packit Service fa4841
	if (freerdp_load_static_channel_addin_entry)
Packit Service fa4841
		entry = freerdp_load_static_channel_addin_entry(pszName, pszSubsystem, pszType, dwFlags);
Packit Service fa4841
Packit Service fa4841
	if (!entry)
Packit Service fa4841
		entry = freerdp_load_dynamic_channel_addin_entry(pszName, pszSubsystem, pszType, dwFlags);
Packit Service fa4841
Packit Service fa4841
	if (!entry)
Packit Service fa4841
		WLog_WARN(TAG, "Failed to load channel %s [%s]", pszName, pszSubsystem);
Packit Service fa4841
Packit Service fa4841
	return entry;
Packit Service fa4841
}