FreeRDP/channels/cliprdr/server/cliprdr_main.c

/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Clipboard Virtual Channel Extension
 *
 * Copyright 2013 Marc-Andre Moreau <marcandre.moreau@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <winpr/crt.h>
#include <winpr/print.h>
#include <winpr/stream.h>

#include <freerdp/channels/log.h>
#include "cliprdr_main.h"

/**
 *                                    Initialization Sequence\n
 *     Client                                                                    Server\n
 *        |                                                                         |\n
 *        |<----------------------Server Clipboard Capabilities PDU-----------------|\n
 *        |<-----------------------------Monitor Ready PDU--------------------------|\n
 *        |-----------------------Client Clipboard Capabilities PDU---------------->|\n
 *        |---------------------------Temporary Directory PDU---------------------->|\n
 *        |-------------------------------Format List PDU-------------------------->|\n
 *        |<--------------------------Format List Response PDU----------------------|\n
 *
 */

/**
 *                                    Data Transfer Sequences\n
 *     Shared                                                                     Local\n
 *  Clipboard Owner                                                           Clipboard Owner\n
 *        |                                                                         |\n
 *        |-------------------------------------------------------------------------|\n _
 *        |-------------------------------Format List PDU-------------------------->|\n  |
 *        |<--------------------------Format List Response PDU----------------------|\n _| Copy Sequence
 *        |<---------------------Lock Clipboard Data PDU (Optional)-----------------|\n
 *        |-------------------------------------------------------------------------|\n
 *        |-------------------------------------------------------------------------|\n _
 *        |<--------------------------Format Data Request PDU-----------------------|\n  | Paste Sequence Palette,
 *        |---------------------------Format Data Response PDU--------------------->|\n _| Metafile, File List Data
 *        |-------------------------------------------------------------------------|\n
 *        |-------------------------------------------------------------------------|\n _
 *        |<------------------------Format Contents Request PDU---------------------|\n  | Paste Sequence
 *        |-------------------------Format Contents Response PDU------------------->|\n _| File Stream Data
 *        |<---------------------Lock Clipboard Data PDU (Optional)-----------------|\n
 *        |-------------------------------------------------------------------------|\n
 *
 */

static int cliprdr_server_send_capabilities(CliprdrServerContext* context)
{
	wStream* s;
	BOOL status;
	UINT32 generalFlags;
	CLIPRDR_HEADER header;
	ULONG written;
	WLog_DBG(TAG, "CliprdrServerSendCapabilities");
	header.msgType = CB_CLIP_CAPS;
	header.msgFlags = 0;
	header.dataLen = 16;

	generalFlags = 0;

	if (context->priv->UseLongFormatNames)
		generalFlags |= CB_USE_LONG_FORMAT_NAMES;

	s = Stream_New(NULL, header.dataLen + CLIPRDR_HEADER_LENGTH);

	Stream_Write_UINT16(s, header.msgType); /* msgType (2 bytes) */
	Stream_Write_UINT16(s, header.msgFlags); /* msgFlags (2 bytes) */
	Stream_Write_UINT32(s, header.dataLen); /* dataLen (4 bytes) */

	Stream_Write_UINT16(s, 1); /* cCapabilitiesSets (2 bytes) */
	Stream_Write_UINT16(s, 0); /* pad1 (2 bytes) */

	Stream_Write_UINT16(s, CB_CAPSTYPE_GENERAL); /* capabilitySetType (2 bytes) */
	Stream_Write_UINT16(s, CB_CAPSTYPE_GENERAL_LEN); /* lengthCapability (2 bytes) */
	Stream_Write_UINT32(s, CB_CAPS_VERSION_2); /* version (4 bytes) */
	Stream_Write_UINT32(s, generalFlags); /* generalFlags (4 bytes) */

	Stream_SealLength(s);

	status = WTSVirtualChannelWrite(context->priv->ChannelHandle, (PCHAR) Stream_Buffer(s), Stream_Length(s), &written);

	Stream_Free(s, TRUE);

	return 0;
}

static int cliprdr_server_send_monitor_ready(CliprdrServerContext* context)
{
	wStream* s;
	BOOL status;
	CLIPRDR_HEADER header;
	ULONG written;
	WLog_DBG(TAG, "CliprdrServerSendMonitorReady");
	header.msgType = CB_MONITOR_READY;
	header.msgFlags = 0;
	header.dataLen = 0;

	s = Stream_New(NULL, header.dataLen + CLIPRDR_HEADER_LENGTH);

	Stream_Write_UINT16(s, header.msgType); /* msgType (2 bytes) */
	Stream_Write_UINT16(s, header.msgFlags); /* msgFlags (2 bytes) */
	Stream_Write_UINT32(s, header.dataLen); /* dataLen (4 bytes) */

	Stream_SealLength(s);

	status = WTSVirtualChannelWrite(context->priv->ChannelHandle, (PCHAR) Stream_Buffer(s), Stream_Length(s), &written);

	Stream_Free(s, TRUE);

	return 0;
}

static int cliprdr_server_send_format_list_response(CliprdrServerContext* context)
{
	wStream* s;
	BOOL status;
	CLIPRDR_HEADER header;
	ULONG written;
	WLog_DBG(TAG, "CliprdrServerSendFormatListResponse");
	header.msgType = CB_FORMAT_LIST_RESPONSE;
	header.msgFlags = CB_RESPONSE_OK;
	header.dataLen = 0;

	s = Stream_New(NULL, header.dataLen + CLIPRDR_HEADER_LENGTH);

	Stream_Write_UINT16(s, header.msgType); /* msgType (2 bytes) */
	Stream_Write_UINT16(s, header.msgFlags); /* msgFlags (2 bytes) */
	Stream_Write_UINT32(s, header.dataLen); /* dataLen (4 bytes) */

	Stream_SealLength(s);

	status = WTSVirtualChannelWrite(context->priv->ChannelHandle, (PCHAR) Stream_Buffer(s), Stream_Length(s), &written);

	Stream_Free(s, TRUE);

	return 0;
}

static int cliprdr_server_receive_capabilities(CliprdrServerContext* context, wStream* s, CLIPRDR_HEADER* header)
{
	UINT32 version;
	UINT32 generalFlags;
	UINT16 cCapabilitiesSets;
	UINT16 capabilitySetType;
	UINT16 lengthCapability;

	Stream_Read_UINT16(s, cCapabilitiesSets); /* cCapabilitiesSets (2 bytes) */
	Stream_Seek_UINT16(s); /* pad1 (2 bytes) */

	Stream_Read_UINT16(s, capabilitySetType); /* capabilitySetType (2 bytes) */
	Stream_Read_UINT16(s, lengthCapability); /* lengthCapability (2 bytes) */

	Stream_Read_UINT32(s, version); /* version (4 bytes) */
	Stream_Read_UINT32(s, generalFlags); /* generalFlags (4 bytes) */

	if (generalFlags & CB_USE_LONG_FORMAT_NAMES)
		context->priv->UseLongFormatNames = TRUE;

	if (generalFlags & CB_STREAM_FILECLIP_ENABLED)
		context->priv->StreamFileClipEnabled = TRUE;

	if (generalFlags & CB_FILECLIP_NO_FILE_PATHS)
		context->priv->FileClipNoFilePaths = TRUE;

	if (generalFlags & CB_CAN_LOCK_CLIPDATA)
		context->priv->CanLockClipData = TRUE;

	return 0;
}

static int cliprdr_server_receive_temporary_directory(CliprdrServerContext* context, wStream* s, CLIPRDR_HEADER* header)
{
	WCHAR* wszTempDir;

	if (Stream_GetRemainingLength(s) < 520)
		return -1;

	wszTempDir = (WCHAR*) Stream_Pointer(s);

	if (wszTempDir[260] != 0)
		return -1;

	ConvertFromUnicode(CP_UTF8, 0, wszTempDir, -1,
					   &(context->priv->ClientTemporaryDirectory), 0, NULL, NULL);
	WLog_DBG(TAG, "ClientTemporaryDirectory: %s", context->priv->ClientTemporaryDirectory);
	return 0;
}

int cliprdr_wcslen(const WCHAR* str, const WCHAR* end)
{
	WCHAR* p = (WCHAR*) str;

	if (!p)
		return -1;

	while (*p)
	{
		if (p == end)
			return -1;

		p++;
	}

	return (p - str);
}

static void cliprdr_free_format_list(UINT32 count, CLIPRDR_FORMAT_NAME* formatNames)
{
	int i;

	if (formatNames)
	{
		for (i = 0; i < count; i++)
		{
			free(formatNames[i].name);
		}

		free(formatNames);
	}
}

static int cliprdr_server_receive_long_format_list(CliprdrServerContext* context, wStream* s, CLIPRDR_HEADER* header)
{
	int i;
	WCHAR* end;
	int length;
	int position;
	WLog_DBG(TAG, "");
	position = Stream_GetPosition(s);
	Stream_SetPosition(s, Stream_Length(s));
	end = (WCHAR*) Stream_Pointer(s);
	Stream_SetPosition(s, position);

	cliprdr_free_format_list(context->priv->ClientFormatNameCount, context->priv->ClientFormatNames);
	context->priv->ClientFormatNameCount = 0;
	context->priv->ClientFormatNames = NULL;

	while (Stream_GetRemainingLength(s) >= 6)
	{
		Stream_Seek(s, 4); /* formatId (4 bytes) */

		length = cliprdr_wcslen((WCHAR*) Stream_Pointer(s), end);

		if (length < 0)
			return -1;

		Stream_Seek(s, (length + 1) * 2); /* wszFormatName */

		context->priv->ClientFormatNameCount++;
	}

	context->priv->ClientFormatNames = (CLIPRDR_FORMAT_NAME*)
			malloc(sizeof(CLIPRDR_FORMAT_NAME) * context->priv->ClientFormatNameCount);

	Stream_SetPosition(s, position);

	for (i = 0; i < context->priv->ClientFormatNameCount; i++)
	{
		Stream_Read_UINT32(s, context->priv->ClientFormatNames[i].id); /* formatId (4 bytes) */

		length = cliprdr_wcslen((WCHAR*) Stream_Pointer(s), end);

		context->priv->ClientFormatNames[i].name = NULL;

		if (length)
		{
			context->priv->ClientFormatNames[i].length = ConvertFromUnicode(CP_UTF8, 0, (WCHAR*) Stream_Pointer(s),
					-1, &(context->priv->ClientFormatNames[i].name), 0, NULL, NULL) - 1;
		}
		else
		{
			context->priv->ClientFormatNames[i].length = 0;
		}

		Stream_Seek(s, (length + 1) * 2); /* wszFormatName */
	}

	for (i = 0; i < context->priv->ClientFormatNameCount; i++)
	{
		WLog_DBG(TAG, "Format %d: Id: 0x%04X Name: %s Length: %d", i,
				 context->priv->ClientFormatNames[i].id,
				 context->priv->ClientFormatNames[i].name,
				 context->priv->ClientFormatNames[i].length);
	}

	return 0;
}

static int cliprdr_server_receive_short_format_list(CliprdrServerContext* context, wStream* s, CLIPRDR_HEADER* header)
{
	WLog_ERR(TAG, "%s: unimplemented");
	return 0;
}

static int cliprdr_server_receive_format_list(CliprdrServerContext* context, wStream* s, CLIPRDR_HEADER* header)
{
	int status;

	if (context->priv->UseLongFormatNames)
	{
		status = cliprdr_server_receive_long_format_list(context, s, header);
	}
	else
	{
		status = cliprdr_server_receive_short_format_list(context, s, header);
	}

	cliprdr_server_send_format_list_response(context);

	return status;
}

static int cliprdr_server_receive_pdu(CliprdrServerContext* context, wStream* s, CLIPRDR_HEADER* header)
{
	WLog_DBG(TAG, "CliprdrServerReceivePdu: msgType: %d msgFlags: 0x%08X dataLen: %d",
			 header->msgType, header->msgFlags, header->dataLen);

	switch (header->msgType)
	{
		case CB_CLIP_CAPS:
			cliprdr_server_receive_capabilities(context, s, header);
			break;

		case CB_TEMP_DIRECTORY:
			cliprdr_server_receive_temporary_directory(context, s, header);
			break;

		case CB_FORMAT_LIST:
			cliprdr_server_receive_format_list(context, s, header);
			break;

		case CB_FORMAT_LIST_RESPONSE:
			break;

		case CB_LOCK_CLIPDATA:
			break;

		case CB_UNLOCK_CLIPDATA:
			break;

		case CB_FORMAT_DATA_REQUEST:
			break;

		case CB_FORMAT_DATA_RESPONSE:
			break;

		case CB_FILECONTENTS_REQUEST:
			break;

		case CB_FILECONTENTS_RESPONSE:
			break;

		default:
			WLog_DBG(TAG, "Unexpected clipboard PDU type: %d", header->msgType);
			break;
	}

	return 0;
}

static void* cliprdr_server_thread(void* arg)
{
	wStream* s;
	DWORD status;
	DWORD nCount;
	void* buffer;
	int position;
	HANDLE events[8];
	HANDLE ChannelEvent;
	DWORD BytesReturned;
	CLIPRDR_HEADER header;
	CliprdrServerContext* context;

	context = (CliprdrServerContext*) arg;

	buffer = NULL;
	BytesReturned = 0;
	ChannelEvent = NULL;

	s = Stream_New(NULL, 4096);

	if (WTSVirtualChannelQuery(context->priv->ChannelHandle, WTSVirtualEventHandle, &buffer, &BytesReturned) == TRUE)
	{
		if (BytesReturned == sizeof(HANDLE))
			CopyMemory(&ChannelEvent, buffer, sizeof(HANDLE));

		WTSFreeMemory(buffer);
	}

	nCount = 0;
	events[nCount++] = ChannelEvent;
	events[nCount++] = context->priv->StopEvent;

	cliprdr_server_send_capabilities(context);
	cliprdr_server_send_monitor_ready(context);

	while (1)
	{
		status = WaitForMultipleObjects(nCount, events, FALSE, INFINITE);

		if (WaitForSingleObject(context->priv->StopEvent, 0) == WAIT_OBJECT_0)
		{
			break;
		}

		WTSVirtualChannelRead(context->priv->ChannelHandle, 0, NULL, 0, &BytesReturned);
		if (BytesReturned < 1)
			continue;
		Stream_EnsureRemainingCapacity(s, BytesReturned);
		if (!WTSVirtualChannelRead(context->priv->ChannelHandle, 0,
			(PCHAR) Stream_Buffer(s), Stream_Capacity(s), &BytesReturned))
		{
			break;
		}

		if (Stream_GetPosition(s) >= CLIPRDR_HEADER_LENGTH)
		{
			position = Stream_GetPosition(s);
			Stream_SetPosition(s, 0);

			Stream_Read_UINT16(s, header.msgType); /* msgType (2 bytes) */
			Stream_Read_UINT16(s, header.msgFlags); /* msgFlags (2 bytes) */
			Stream_Read_UINT32(s, header.dataLen); /* dataLen (4 bytes) */

			Stream_SetPosition(s, position);

			if (Stream_GetPosition(s) >= (header.dataLen + CLIPRDR_HEADER_LENGTH))
			{
				Stream_SealLength(s);
				Stream_SetPosition(s, CLIPRDR_HEADER_LENGTH);

				cliprdr_server_receive_pdu(context, s, &header);
				Stream_SetPosition(s, 0);
			}
		}
	}

	Stream_Free(s, TRUE);

	return NULL;
}

static int cliprdr_server_start(CliprdrServerContext* context)
{
	context->priv->ChannelHandle = WTSVirtualChannelOpen(context->vcm, WTS_CURRENT_SESSION, "cliprdr");

	if (!context->priv->ChannelHandle)
		return -1;

	context->priv->StopEvent = CreateEvent(NULL, TRUE, FALSE, NULL);

	context->priv->Thread = CreateThread(NULL, 0,
			(LPTHREAD_START_ROUTINE) cliprdr_server_thread, (void*) context, 0, NULL);

	return 0;
}

static int cliprdr_server_stop(CliprdrServerContext* context)
{
	SetEvent(context->priv->StopEvent);

	WaitForSingleObject(context->priv->Thread, INFINITE);
	CloseHandle(context->priv->Thread);

	return 0;
}

CliprdrServerContext* cliprdr_server_context_new(HANDLE vcm)
{
	CliprdrServerContext* context;

	context = (CliprdrServerContext*) calloc(1, sizeof(CliprdrServerContext));

	if (context)
	{
		context->vcm = vcm;

		context->Start = cliprdr_server_start;
		context->Stop = cliprdr_server_stop;

		context->priv = (CliprdrServerPrivate*) malloc(sizeof(CliprdrServerPrivate));

		if (context->priv)
		{
			ZeroMemory(context->priv, sizeof(CliprdrServerPrivate));

			context->priv->UseLongFormatNames = TRUE;
			context->priv->StreamFileClipEnabled = TRUE;
			context->priv->FileClipNoFilePaths = TRUE;
			context->priv->CanLockClipData = TRUE;
		}
	}

	return context;
}

void cliprdr_server_context_free(CliprdrServerContext* context)
{
	if (context)
	{
		if (context->priv)
		{
			free(context->priv);
		}

		free(context);
	}
}