25#include <freerdp/config.h>
28#include <winpr/cast.h>
30#include <freerdp/channels/log.h>
31#include <freerdp/freerdp.h>
33#include "rail_orders.h"
35static BOOL rail_is_feature_supported(
const rdpContext* context, UINT32 featureMask);
44 char buffer[128] = WINPR_C_ARRAY_INIT;
49 return ERROR_INVALID_PARAMETER;
52 const UINT16 orderLength = (UINT16)Stream_GetPosition(s);
53 Stream_ResetPosition(s);
54 if (!rail_write_pdu_header(s, orderType, orderLength))
56 if (!Stream_SetPosition(s, orderLength))
58 WLog_Print(rail->log, WLOG_DEBUG,
"Sending %s PDU, length: %" PRIu16
"",
59 rail_get_order_type_string_full(orderType, buffer,
sizeof(buffer)), orderLength);
60 return rail_send_channel_data(rail, s);
64 return ERROR_INVALID_DATA;
74 if (!s || !execResult)
75 return ERROR_INVALID_PARAMETER;
77 if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_EXEC_RESULT_ORDER_LENGTH))
78 return ERROR_INVALID_DATA;
80 Stream_Read_UINT16(s, execResult->flags);
81 Stream_Read_UINT16(s, execResult->execResult);
82 Stream_Read_UINT32(s, execResult->rawResult);
83 Stream_Seek_UINT16(s);
84 return rail_read_unicode_string(s, &execResult->exeOrFile)
86 : ERROR_INTERNAL_ERROR;
96 if (!s || !minmaxinfo)
97 return ERROR_INVALID_PARAMETER;
99 if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_MINMAXINFO_ORDER_LENGTH))
100 return ERROR_INVALID_DATA;
102 Stream_Read_UINT32(s, minmaxinfo->windowId);
103 Stream_Read_INT16(s, minmaxinfo->maxWidth);
104 Stream_Read_INT16(s, minmaxinfo->maxHeight);
105 Stream_Read_INT16(s, minmaxinfo->maxPosX);
106 Stream_Read_INT16(s, minmaxinfo->maxPosY);
107 Stream_Read_INT16(s, minmaxinfo->minTrackWidth);
108 Stream_Read_INT16(s, minmaxinfo->minTrackHeight);
109 Stream_Read_INT16(s, minmaxinfo->maxTrackWidth);
110 Stream_Read_INT16(s, minmaxinfo->maxTrackHeight);
111 return CHANNEL_RC_OK;
119static UINT rail_read_server_localmovesize_order(
wStream* s,
122 UINT16 isMoveSizeStart = 0;
124 if (!s || !localMoveSize)
125 return ERROR_INVALID_PARAMETER;
127 if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_LOCALMOVESIZE_ORDER_LENGTH))
128 return ERROR_INVALID_DATA;
130 Stream_Read_UINT32(s, localMoveSize->windowId);
131 Stream_Read_UINT16(s, isMoveSizeStart);
132 localMoveSize->isMoveSizeStart = (isMoveSizeStart != 0);
133 Stream_Read_UINT16(s, localMoveSize->moveSizeType);
134 Stream_Read_INT16(s, localMoveSize->posX);
135 Stream_Read_INT16(s, localMoveSize->posY);
136 return CHANNEL_RC_OK;
144static UINT rail_read_server_get_appid_resp_order(
wStream* s,
147 if (!s || !getAppidResp)
148 return ERROR_INVALID_PARAMETER;
150 if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_GET_APPID_RESP_ORDER_LENGTH))
151 return ERROR_INVALID_DATA;
153 Stream_Read_UINT32(s, getAppidResp->windowId);
154 if (!Stream_Read_UTF16_String(
155 s, getAppidResp->applicationId,
156 ARRAYSIZE(getAppidResp->applicationId)))
157 return ERROR_INVALID_DATA;
158 return CHANNEL_RC_OK;
168 if (!s || !langbarInfo)
169 return ERROR_INVALID_PARAMETER;
171 if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_LANGBAR_INFO_ORDER_LENGTH))
172 return ERROR_INVALID_DATA;
174 Stream_Read_UINT32(s, langbarInfo->languageBarStatus);
175 return CHANNEL_RC_OK;
180 if (!s || !clientStatus)
181 return ERROR_INVALID_PARAMETER;
183 Stream_Write_UINT32(s, clientStatus->flags);
184 return ERROR_SUCCESS;
192static UINT rail_write_client_exec_order(
wStream* s, UINT16 flags,
199 if (!s || !exeOrFile || !workingDir || !arguments)
200 return ERROR_INVALID_PARAMETER;
204 if ((exeOrFile->length > 520) || (workingDir->length > 520) || (arguments->length > 16000))
207 "TS_RAIL_ORDER_EXEC argument limits exceeded: ExeOrFile=%" PRIu16
208 " [max=520], WorkingDir=%" PRIu16
" [max=520], Arguments=%" PRIu16
" [max=16000]",
209 exeOrFile->length, workingDir->length, arguments->length);
210 return ERROR_BAD_ARGUMENTS;
213 Stream_Write_UINT16(s, flags);
214 Stream_Write_UINT16(s, exeOrFile->length);
215 Stream_Write_UINT16(s, workingDir->length);
216 Stream_Write_UINT16(s, arguments->length);
218 if ((error = rail_write_unicode_string_value(s, exeOrFile)))
220 WLog_ERR(TAG,
"rail_write_unicode_string_value failed with error %" PRIu32
"", error);
224 if ((error = rail_write_unicode_string_value(s, workingDir)))
226 WLog_ERR(TAG,
"rail_write_unicode_string_value failed with error %" PRIu32
"", error);
230 if ((error = rail_write_unicode_string_value(s, arguments)))
232 WLog_ERR(TAG,
"rail_write_unicode_string_value failed with error %" PRIu32
"", error);
244 return ERROR_INVALID_PARAMETER;
246 Stream_Write_UINT32(s, activate->windowId);
247 enabled = activate->enabled ? 1 : 0;
248 Stream_Write_UINT8(s, enabled);
249 return ERROR_SUCCESS;
255 return ERROR_INVALID_PARAMETER;
257 Stream_Write_UINT32(s, sysmenu->windowId);
258 Stream_Write_INT16(s, sysmenu->left);
259 Stream_Write_INT16(s, sysmenu->top);
260 return ERROR_SUCCESS;
265 if (!s || !syscommand)
266 return ERROR_INVALID_PARAMETER;
268 Stream_Write_UINT32(s, syscommand->windowId);
269 Stream_Write_UINT16(s, syscommand->command);
270 return ERROR_SUCCESS;
273static UINT rail_write_client_notify_event_order(
wStream* s,
276 if (!s || !notifyEvent)
277 return ERROR_INVALID_PARAMETER;
279 Stream_Write_UINT32(s, notifyEvent->windowId);
280 Stream_Write_UINT32(s, notifyEvent->notifyIconId);
281 Stream_Write_UINT32(s, notifyEvent->message);
282 return ERROR_SUCCESS;
285static UINT rail_write_client_window_move_order(
wStream* s,
288 if (!s || !windowMove)
289 return ERROR_INVALID_PARAMETER;
291 Stream_Write_UINT32(s, windowMove->windowId);
292 Stream_Write_INT16(s, windowMove->left);
293 Stream_Write_INT16(s, windowMove->top);
294 Stream_Write_INT16(s, windowMove->right);
295 Stream_Write_INT16(s, windowMove->bottom);
296 return ERROR_SUCCESS;
299static UINT rail_write_client_get_appid_req_order(
wStream* s,
302 if (!s || !getAppidReq)
303 return ERROR_INVALID_PARAMETER;
305 Stream_Write_UINT32(s, getAppidReq->windowId);
306 return ERROR_SUCCESS;
311 if (!s || !langbarInfo)
312 return ERROR_INVALID_PARAMETER;
314 Stream_Write_UINT32(s, langbarInfo->languageBarStatus);
315 return ERROR_SUCCESS;
318static UINT rail_write_languageime_info_order(
wStream* s,
321 if (!s || !langImeInfo)
322 return ERROR_INVALID_PARAMETER;
324 Stream_Write_UINT32(s, langImeInfo->ProfileType);
325 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(UINT16, langImeInfo->LanguageID));
326 Stream_Write(s, &langImeInfo->LanguageProfileCLSID,
sizeof(langImeInfo->LanguageProfileCLSID));
327 Stream_Write(s, &langImeInfo->ProfileGUID,
sizeof(langImeInfo->ProfileGUID));
328 Stream_Write_UINT32(s, langImeInfo->KeyboardLayout);
329 return ERROR_SUCCESS;
332static UINT rail_write_compartment_info_order(
wStream* s,
335 if (!s || !compartmentInfo)
336 return ERROR_INVALID_PARAMETER;
338 Stream_Write_UINT32(s, compartmentInfo->ImeState);
339 Stream_Write_UINT32(s, compartmentInfo->ImeConvMode);
340 Stream_Write_UINT32(s, compartmentInfo->ImeSentenceMode);
341 Stream_Write_UINT32(s, compartmentInfo->KanaMode);
342 return ERROR_SUCCESS;
352 RailClientContext* context = rail_get_client_interface(rail);
357 return ERROR_INVALID_PARAMETER;
359 if ((error = rail_read_handshake_order(s, &serverHandshake)))
361 WLog_ERR(TAG,
"rail_read_handshake_order failed with error %" PRIu32
"!", error);
365 rail->channelBuildNumber = serverHandshake.buildNumber;
367 if (rail->sendHandshake)
370 clientHandshake.buildNumber = 0x00001DB0;
371 error = context->ClientHandshake(context, &clientHandshake);
374 if (error != CHANNEL_RC_OK)
379 IFCALLRET(context->ServerHandshake, error, context, &serverHandshake);
382 WLog_ERR(TAG,
"context.ServerHandshake failed with error %" PRIu32
"", error);
388static UINT rail_read_compartment_info_order(
wStream* s,
391 if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_COMPARTMENT_INFO_ORDER_LENGTH))
392 return ERROR_INVALID_DATA;
394 Stream_Read_UINT32(s, compartmentInfo->ImeState);
395 Stream_Read_UINT32(s, compartmentInfo->ImeConvMode);
396 Stream_Read_UINT32(s, compartmentInfo->ImeSentenceMode);
397 Stream_Read_UINT32(s, compartmentInfo->KanaMode);
398 return CHANNEL_RC_OK;
403 RailClientContext* context = rail_get_client_interface(rail);
408 return ERROR_INVALID_PARAMETER;
410 if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED))
411 return ERROR_BAD_CONFIGURATION;
413 if ((error = rail_read_compartment_info_order(s, &pdu)))
418 IFCALLRET(context->ClientCompartmentInfo, error, context, &pdu);
421 WLog_ERR(TAG,
"context.ClientCompartmentInfo failed with error %" PRIu32
"", error);
427BOOL rail_is_feature_supported(
const rdpContext* context, UINT32 featureMask)
429 UINT32 supported = 0;
432 if (!context || !context->settings)
439 supported = level & mask;
440 masked = (supported & featureMask);
442 if (masked != featureMask)
444 char maskstr[256] = WINPR_C_ARRAY_INIT;
445 char actualstr[256] = WINPR_C_ARRAY_INIT;
447 WLog_WARN(TAG,
"have %s, require %s",
463 RailClientContext* context = rail_get_client_interface(rail);
467 if (!rail || !context || !s)
468 return ERROR_INVALID_PARAMETER;
470 if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_HANDSHAKE_EX_SUPPORTED))
471 return ERROR_BAD_CONFIGURATION;
473 if ((error = rail_read_handshake_ex_order(s, &serverHandshake)))
475 WLog_ERR(TAG,
"rail_read_handshake_ex_order failed with error %" PRIu32
"!", error);
479 rail->channelBuildNumber = serverHandshake.buildNumber;
480 rail->channelFlags = serverHandshake.railHandshakeFlags;
483 char buffer[192] = WINPR_C_ARRAY_INIT;
484 WLog_DBG(TAG,
"HandshakeFlags=%s [buildNumber=0x%08" PRIx32
"]",
485 rail_handshake_ex_flags_to_string(rail->channelFlags, buffer,
sizeof(buffer)),
486 rail->channelBuildNumber);
489 if (rail->sendHandshake)
492 clientHandshake.buildNumber = 0x00001DB0;
495 error = context->ClientHandshake(context, &clientHandshake);
498 if (error != CHANNEL_RC_OK)
503 IFCALLRET(context->ServerHandshakeEx, error, context, &serverHandshake);
506 WLog_ERR(TAG,
"context.ServerHandshakeEx failed with error %" PRIu32
"", error);
519 RailClientContext* context = rail_get_client_interface(rail);
524 return ERROR_INVALID_PARAMETER;
526 if ((error = rail_read_server_exec_result_order(s, &execResult)))
528 WLog_ERR(TAG,
"rail_read_server_exec_result_order failed with error %" PRIu32
"!", error);
534 IFCALLRET(context->ServerExecuteResult, error, context, &execResult);
537 WLog_ERR(TAG,
"context.ServerExecuteResult failed with error %" PRIu32
"", error);
541 free(execResult.exeOrFile.string);
552 RailClientContext* context = rail_get_client_interface(rail);
555 BOOL extendedSpiSupported = 0;
558 return ERROR_INVALID_PARAMETER;
560 extendedSpiSupported = rail_is_extended_spi_supported(rail->channelFlags);
561 if ((error = rail_read_sysparam_order(s, &sysparam, extendedSpiSupported)))
563 WLog_ERR(TAG,
"rail_read_sysparam_order failed with error %" PRIu32
"!", error);
569 IFCALLRET(context->ServerSystemParam, error, context, &sysparam);
572 WLog_ERR(TAG,
"context.ServerSystemParam failed with error %" PRIu32
"", error);
585 RailClientContext* context = rail_get_client_interface(rail);
590 return ERROR_INVALID_PARAMETER;
592 if ((error = rail_read_server_minmaxinfo_order(s, &minMaxInfo)))
594 WLog_ERR(TAG,
"rail_read_server_minmaxinfo_order failed with error %" PRIu32
"!", error);
600 IFCALLRET(context->ServerMinMaxInfo, error, context, &minMaxInfo);
603 WLog_ERR(TAG,
"context.ServerMinMaxInfo failed with error %" PRIu32
"", error);
616 RailClientContext* context = rail_get_client_interface(rail);
621 return ERROR_INVALID_PARAMETER;
623 if ((error = rail_read_server_localmovesize_order(s, &localMoveSize)))
625 WLog_ERR(TAG,
"rail_read_server_localmovesize_order failed with error %" PRIu32
"!", error);
631 IFCALLRET(context->ServerLocalMoveSize, error, context, &localMoveSize);
634 WLog_ERR(TAG,
"context.ServerLocalMoveSize failed with error %" PRIu32
"", error);
647 RailClientContext* context = rail_get_client_interface(rail);
652 return ERROR_INVALID_PARAMETER;
654 if ((error = rail_read_server_get_appid_resp_order(s, &getAppIdResp)))
656 WLog_ERR(TAG,
"rail_read_server_get_appid_resp_order failed with error %" PRIu32
"!",
663 IFCALLRET(context->ServerGetAppIdResponse, error, context, &getAppIdResp);
666 WLog_ERR(TAG,
"context.ServerGetAppIdResponse failed with error %" PRIu32
"", error);
679 RailClientContext* context = rail_get_client_interface(rail);
684 return ERROR_INVALID_PARAMETER;
686 if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED))
687 return ERROR_BAD_CONFIGURATION;
689 if ((error = rail_read_langbar_info_order(s, &langBarInfo)))
691 WLog_ERR(TAG,
"rail_read_langbar_info_order failed with error %" PRIu32
"!", error);
697 IFCALLRET(context->ServerLanguageBarInfo, error, context, &langBarInfo);
700 WLog_ERR(TAG,
"context.ServerLanguageBarInfo failed with error %" PRIu32
"", error);
708 if (!s || !taskbarInfo)
709 return ERROR_INVALID_PARAMETER;
711 if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_TASKBAR_INFO_ORDER_LENGTH))
712 return ERROR_INVALID_DATA;
714 Stream_Read_UINT32(s, taskbarInfo->TaskbarMessage);
715 Stream_Read_UINT32(s, taskbarInfo->WindowIdTab);
716 Stream_Read_UINT32(s, taskbarInfo->Body);
717 return CHANNEL_RC_OK;
722 RailClientContext* context = rail_get_client_interface(rail);
727 return ERROR_INVALID_PARAMETER;
731 if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_SHELL_INTEGRATION_SUPPORTED))
732 return ERROR_BAD_CONFIGURATION;
734 if ((error = rail_read_taskbar_info_order(s, &taskBarInfo)))
736 WLog_ERR(TAG,
"rail_read_langbar_info_order failed with error %" PRIu32
"!", error);
742 IFCALLRET(context->ServerTaskBarInfo, error, context, &taskBarInfo);
745 WLog_ERR(TAG,
"context.ServerTaskBarInfo failed with error %" PRIu32
"", error);
754 return ERROR_INVALID_PARAMETER;
756 if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_Z_ORDER_SYNC_ORDER_LENGTH))
757 return ERROR_INVALID_DATA;
759 Stream_Read_UINT32(s, zorder->windowIdMarker);
760 return CHANNEL_RC_OK;
765 RailClientContext* context = rail_get_client_interface(rail);
770 return ERROR_INVALID_PARAMETER;
772 if ((rail->clientStatus.flags & TS_RAIL_CLIENTSTATUS_ZORDER_SYNC) == 0)
773 return ERROR_INVALID_DATA;
775 if ((error = rail_read_zorder_sync_order(s, &zorder)))
777 WLog_ERR(TAG,
"rail_read_zorder_sync_order failed with error %" PRIu32
"!", error);
783 IFCALLRET(context->ServerZOrderSync, error, context, &zorder);
786 WLog_ERR(TAG,
"context.ServerZOrderSync failed with error %" PRIu32
"", error);
796 if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_CLOAK_ORDER_LENGTH))
797 return ERROR_INVALID_DATA;
799 Stream_Read_UINT32(s, cloak->windowId);
800 Stream_Read_UINT8(s, cloaked);
801 cloak->cloak = (cloaked != 0);
802 return CHANNEL_RC_OK;
807 RailClientContext* context = rail_get_client_interface(rail);
812 return ERROR_INVALID_PARAMETER;
816 if ((rail->clientStatus.flags & TS_RAIL_CLIENTSTATUS_BIDIRECTIONAL_CLOAK_SUPPORTED) == 0)
817 return ERROR_INVALID_DATA;
819 if ((error = rail_read_cloak_order(s, &cloak)))
821 WLog_ERR(TAG,
"rail_read_zorder_sync_order failed with error %" PRIu32
"!", error);
827 IFCALLRET(context->ServerCloak, error, context, &cloak);
830 WLog_ERR(TAG,
"context.ServerZOrderSync failed with error %" PRIu32
"", error);
841 return ERROR_INVALID_PARAMETER;
843 if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_POWER_DISPLAY_REQUEST_ORDER_LENGTH))
844 return ERROR_INVALID_DATA;
846 Stream_Read_UINT32(s, active);
847 power->active = active != 0;
848 return CHANNEL_RC_OK;
853 RailClientContext* context = rail_get_client_interface(rail);
858 return ERROR_INVALID_PARAMETER;
862 if ((rail->clientStatus.flags & TS_RAIL_CLIENTSTATUS_POWER_DISPLAY_REQUEST_SUPPORTED) == 0)
863 return ERROR_INVALID_DATA;
865 if ((error = rail_read_power_display_request_order(s, &power)))
867 WLog_ERR(TAG,
"rail_read_zorder_sync_order failed with error %" PRIu32
"!", error);
873 IFCALLRET(context->ServerPowerDisplayRequest, error, context, &power);
876 WLog_ERR(TAG,
"context.ServerPowerDisplayRequest failed with error %" PRIu32
"", error);
882static UINT rail_read_get_application_id_extended_response_order(
wStream* s,
886 return ERROR_INVALID_PARAMETER;
888 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
889 return ERROR_INVALID_DATA;
891 Stream_Read_UINT32(s, id->windowID);
893 if (!Stream_Read_UTF16_String(s, id->applicationID, ARRAYSIZE(id->applicationID)))
894 return ERROR_INVALID_DATA;
896 if (_wcsnlen(id->applicationID, ARRAYSIZE(id->applicationID)) >= ARRAYSIZE(id->applicationID))
897 return ERROR_INVALID_DATA;
899 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
900 return ERROR_INVALID_DATA;
902 Stream_Read_UINT32(s, id->processId);
904 if (!Stream_Read_UTF16_String(s, id->processImageName, ARRAYSIZE(id->processImageName)))
905 return ERROR_INVALID_DATA;
907 if (_wcsnlen(id->applicationID, ARRAYSIZE(id->processImageName)) >=
908 ARRAYSIZE(id->processImageName))
909 return ERROR_INVALID_DATA;
911 return CHANNEL_RC_OK;
914static UINT rail_recv_get_application_id_extended_response_order(
railPlugin* rail,
wStream* s)
916 RailClientContext* context = rail_get_client_interface(rail);
921 return ERROR_INVALID_PARAMETER;
923 if ((error = rail_read_get_application_id_extended_response_order(s, &
id)))
926 "rail_read_get_application_id_extended_response_order failed with error %" PRIu32
934 IFCALLRET(context->ServerGetAppidResponseExtended, error, context, &
id);
937 WLog_ERR(TAG,
"context.ServerGetAppidResponseExtended failed with error %" PRIu32
"",
944static UINT rail_read_textscaleinfo_order(
wStream* s, UINT32* pTextScaleFactor)
946 WINPR_ASSERT(pTextScaleFactor);
948 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
949 return ERROR_INVALID_DATA;
951 Stream_Read_UINT32(s, *pTextScaleFactor);
952 return CHANNEL_RC_OK;
957 RailClientContext* context = rail_get_client_interface(rail);
958 UINT32 TextScaleFactor = 0;
962 return ERROR_INVALID_PARAMETER;
964 if ((error = rail_read_textscaleinfo_order(s, &TextScaleFactor)))
969 IFCALLRET(context->ClientTextScale, error, context, TextScaleFactor);
972 WLog_ERR(TAG,
"context.ClientTextScale failed with error %" PRIu32
"", error);
978static UINT rail_read_caretblinkinfo_order(
wStream* s, UINT32* pCaretBlinkRate)
980 WINPR_ASSERT(pCaretBlinkRate);
982 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
983 return ERROR_INVALID_DATA;
985 Stream_Read_UINT32(s, *pCaretBlinkRate);
986 return CHANNEL_RC_OK;
991 RailClientContext* context = rail_get_client_interface(rail);
992 UINT32 CaretBlinkRate = 0;
996 return ERROR_INVALID_PARAMETER;
997 if ((error = rail_read_caretblinkinfo_order(s, &CaretBlinkRate)))
1000 if (context->custom)
1002 IFCALLRET(context->ClientCaretBlinkRate, error, context, CaretBlinkRate);
1005 WLog_ERR(TAG,
"context.ClientCaretBlinkRate failed with error %" PRIu32
"", error);
1016UINT rail_order_recv(LPVOID userdata,
wStream* s)
1018 char buffer[128] = WINPR_C_ARRAY_INIT;
1020 UINT16 orderType = 0;
1021 UINT16 orderLength = 0;
1022 UINT error = CHANNEL_RC_OK;
1025 return ERROR_INVALID_PARAMETER;
1027 if ((error = rail_read_pdu_header(s, &orderType, &orderLength)))
1029 WLog_ERR(TAG,
"rail_read_pdu_header failed with error %" PRIu32
"!", error);
1033 WLog_Print(rail->log, WLOG_DEBUG,
"Received %s PDU, length:%" PRIu16
"",
1034 rail_get_order_type_string_full(orderType, buffer,
sizeof(buffer)), orderLength);
1038 case TS_RAIL_ORDER_HANDSHAKE:
1039 error = rail_recv_handshake_order(rail, s);
1042 case TS_RAIL_ORDER_COMPARTMENTINFO:
1043 error = rail_recv_compartmentinfo_order(rail, s);
1046 case TS_RAIL_ORDER_HANDSHAKE_EX:
1047 error = rail_recv_handshake_ex_order(rail, s);
1050 case TS_RAIL_ORDER_EXEC_RESULT:
1051 error = rail_recv_exec_result_order(rail, s);
1054 case TS_RAIL_ORDER_SYSPARAM:
1055 error = rail_recv_server_sysparam_order(rail, s);
1058 case TS_RAIL_ORDER_MINMAXINFO:
1059 error = rail_recv_server_minmaxinfo_order(rail, s);
1062 case TS_RAIL_ORDER_LOCALMOVESIZE:
1063 error = rail_recv_server_localmovesize_order(rail, s);
1066 case TS_RAIL_ORDER_GET_APPID_RESP:
1067 error = rail_recv_server_get_appid_resp_order(rail, s);
1070 case TS_RAIL_ORDER_LANGBARINFO:
1071 error = rail_recv_langbar_info_order(rail, s);
1074 case TS_RAIL_ORDER_TASKBARINFO:
1075 error = rail_recv_taskbar_info_order(rail, s);
1078 case TS_RAIL_ORDER_ZORDER_SYNC:
1079 error = rail_recv_zorder_sync_order(rail, s);
1082 case TS_RAIL_ORDER_CLOAK:
1083 error = rail_recv_cloak_order(rail, s);
1086 case TS_RAIL_ORDER_POWER_DISPLAY_REQUEST:
1087 error = rail_recv_power_display_request_order(rail, s);
1090 case TS_RAIL_ORDER_GET_APPID_RESP_EX:
1091 error = rail_recv_get_application_id_extended_response_order(rail, s);
1094 case TS_RAIL_ORDER_TEXTSCALEINFO:
1095 error = rail_recv_textscaleinfo_order(rail, s);
1098 case TS_RAIL_ORDER_CARETBLINKINFO:
1099 error = rail_recv_caretblinkinfo_order(rail, s);
1103 WLog_ERR(TAG,
"Unknown RAIL PDU %s received.",
1104 rail_get_order_type_string_full(orderType, buffer,
sizeof(buffer)));
1105 return ERROR_INVALID_DATA;
1108 if (error != CHANNEL_RC_OK)
1110 char ebuffer[128] = WINPR_C_ARRAY_INIT;
1111 WLog_Print(rail->log, WLOG_ERROR,
"Failed to process rail %s PDU, length:%" PRIu16
"",
1112 rail_get_order_type_string_full(orderType, ebuffer,
sizeof(ebuffer)),
1116 Stream_Free(s, TRUE);
1127 if (!rail || !handshake)
1128 return ERROR_INVALID_PARAMETER;
1130 wStream* s = rail_pdu_init(RAIL_HANDSHAKE_ORDER_LENGTH);
1134 WLog_ERR(TAG,
"rail_pdu_init failed!");
1135 return CHANNEL_RC_NO_MEMORY;
1138 rail_write_handshake_order(s, handshake);
1139 return rail_send_pdu(rail, s, TS_RAIL_ORDER_HANDSHAKE);
1149 if (!rail || !handshakeEx)
1150 return ERROR_INVALID_PARAMETER;
1152 wStream* s = rail_pdu_init(RAIL_HANDSHAKE_EX_ORDER_LENGTH);
1156 WLog_ERR(TAG,
"rail_pdu_init failed!");
1157 return CHANNEL_RC_NO_MEMORY;
1160 rail_write_handshake_ex_order(s, handshakeEx);
1161 return rail_send_pdu(rail, s, TS_RAIL_ORDER_HANDSHAKE_EX);
1174 if (!rail || !clientStatus)
1175 return ERROR_INVALID_PARAMETER;
1177 rail->clientStatus = *clientStatus;
1178 s = rail_pdu_init(RAIL_CLIENT_STATUS_ORDER_LENGTH);
1182 WLog_ERR(TAG,
"rail_pdu_init failed!");
1183 return CHANNEL_RC_NO_MEMORY;
1186 error = rail_write_client_status_order(s, clientStatus);
1188 if (ERROR_SUCCESS != error)
1191 Stream_Free(s, TRUE);
1195 return rail_send_pdu(rail, s, TS_RAIL_ORDER_CLIENTSTATUS);
1203UINT rail_send_client_exec_order(
railPlugin* rail, UINT16 flags,
1212 if (!rail || !exeOrFile || !workingDir || !arguments)
1213 return ERROR_INVALID_PARAMETER;
1215 length = RAIL_EXEC_ORDER_LENGTH + exeOrFile->length + workingDir->length + arguments->length;
1216 s = rail_pdu_init(length);
1220 WLog_ERR(TAG,
"rail_pdu_init failed!");
1221 return CHANNEL_RC_NO_MEMORY;
1224 if ((error = rail_write_client_exec_order(s, flags, exeOrFile, workingDir, arguments)))
1226 WLog_ERR(TAG,
"rail_write_client_exec_order failed with error %" PRIu32
"!", error);
1230 return rail_send_pdu(rail, s, TS_RAIL_ORDER_EXEC);
1233 Stream_Free(s, TRUE);
1247 if (!rail || !activate)
1248 return ERROR_INVALID_PARAMETER;
1250 s = rail_pdu_init(RAIL_ACTIVATE_ORDER_LENGTH);
1254 WLog_ERR(TAG,
"rail_pdu_init failed!");
1255 return CHANNEL_RC_NO_MEMORY;
1258 error = rail_write_client_activate_order(s, activate);
1260 if (ERROR_SUCCESS != error)
1263 Stream_Free(s, TRUE);
1267 return rail_send_pdu(rail, s, TS_RAIL_ORDER_ACTIVATE);
1280 if (!rail || !sysmenu)
1281 return ERROR_INVALID_PARAMETER;
1283 s = rail_pdu_init(RAIL_SYSMENU_ORDER_LENGTH);
1287 WLog_ERR(TAG,
"rail_pdu_init failed!");
1288 return CHANNEL_RC_NO_MEMORY;
1291 error = rail_write_client_sysmenu_order(s, sysmenu);
1293 if (ERROR_SUCCESS != error)
1296 Stream_Free(s, TRUE);
1300 return rail_send_pdu(rail, s, TS_RAIL_ORDER_SYSMENU);
1313 if (!rail || !syscommand)
1314 return ERROR_INVALID_PARAMETER;
1316 s = rail_pdu_init(RAIL_SYSCOMMAND_ORDER_LENGTH);
1320 WLog_ERR(TAG,
"rail_pdu_init failed!");
1321 return CHANNEL_RC_NO_MEMORY;
1324 error = rail_write_client_syscommand_order(s, syscommand);
1326 if (ERROR_SUCCESS != error)
1329 Stream_Free(s, TRUE);
1333 return rail_send_pdu(rail, s, TS_RAIL_ORDER_SYSCOMMAND);
1341UINT rail_send_client_notify_event_order(
railPlugin* rail,
1347 if (!rail || !notifyEvent)
1348 return ERROR_INVALID_PARAMETER;
1350 s = rail_pdu_init(RAIL_NOTIFY_EVENT_ORDER_LENGTH);
1354 WLog_ERR(TAG,
"rail_pdu_init failed!");
1355 return CHANNEL_RC_NO_MEMORY;
1358 error = rail_write_client_notify_event_order(s, notifyEvent);
1360 if (ERROR_SUCCESS != error)
1363 Stream_Free(s, TRUE);
1367 return rail_send_pdu(rail, s, TS_RAIL_ORDER_NOTIFY_EVENT);
1380 if (!rail || !windowMove)
1381 return ERROR_INVALID_PARAMETER;
1383 s = rail_pdu_init(RAIL_WINDOW_MOVE_ORDER_LENGTH);
1387 WLog_ERR(TAG,
"rail_pdu_init failed!");
1388 return CHANNEL_RC_NO_MEMORY;
1391 error = rail_write_client_window_move_order(s, windowMove);
1393 if (ERROR_SUCCESS != error)
1396 Stream_Free(s, TRUE);
1400 return rail_send_pdu(rail, s, TS_RAIL_ORDER_WINDOWMOVE);
1408UINT rail_send_client_get_appid_req_order(
railPlugin* rail,
1414 if (!rail || !getAppIdReq)
1415 return ERROR_INVALID_PARAMETER;
1417 s = rail_pdu_init(RAIL_GET_APPID_REQ_ORDER_LENGTH);
1421 WLog_ERR(TAG,
"rail_pdu_init failed!");
1422 return CHANNEL_RC_NO_MEMORY;
1425 error = rail_write_client_get_appid_req_order(s, getAppIdReq);
1427 if (ERROR_SUCCESS != error)
1430 Stream_Free(s, TRUE);
1433 return rail_send_pdu(rail, s, TS_RAIL_ORDER_GET_APPID_REQ);
1441UINT rail_send_client_langbar_info_order(
railPlugin* rail,
1447 if (!rail || !langBarInfo)
1448 return ERROR_INVALID_PARAMETER;
1450 if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED))
1451 return ERROR_BAD_CONFIGURATION;
1453 s = rail_pdu_init(RAIL_LANGBAR_INFO_ORDER_LENGTH);
1457 WLog_ERR(TAG,
"rail_pdu_init failed!");
1458 return CHANNEL_RC_NO_MEMORY;
1461 error = rail_write_langbar_info_order(s, langBarInfo);
1463 if (ERROR_SUCCESS != error)
1466 Stream_Free(s, TRUE);
1469 return rail_send_pdu(rail, s, TS_RAIL_ORDER_LANGBARINFO);
1472UINT rail_send_client_languageime_info_order(
railPlugin* rail,
1478 if (!rail || !langImeInfo)
1479 return ERROR_INVALID_PARAMETER;
1481 if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED))
1482 return ERROR_BAD_CONFIGURATION;
1484 s = rail_pdu_init(RAIL_LANGUAGEIME_INFO_ORDER_LENGTH);
1488 WLog_ERR(TAG,
"rail_pdu_init failed!");
1489 return CHANNEL_RC_NO_MEMORY;
1492 error = rail_write_languageime_info_order(s, langImeInfo);
1494 if (ERROR_SUCCESS != error)
1497 Stream_Free(s, TRUE);
1500 return rail_send_pdu(rail, s, TS_RAIL_ORDER_LANGUAGEIMEINFO);
1503UINT rail_send_client_compartment_info_order(
railPlugin* rail,
1509 if (!rail || !compartmentInfo)
1510 return ERROR_INVALID_PARAMETER;
1512 if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED))
1513 return ERROR_BAD_CONFIGURATION;
1515 s = rail_pdu_init(RAIL_COMPARTMENT_INFO_ORDER_LENGTH);
1519 WLog_ERR(TAG,
"rail_pdu_init failed!");
1520 return CHANNEL_RC_NO_MEMORY;
1523 error = rail_write_compartment_info_order(s, compartmentInfo);
1525 if (ERROR_SUCCESS != error)
1527 Stream_Free(s, TRUE);
1530 return rail_send_pdu(rail, s, TS_RAIL_ORDER_COMPARTMENTINFO);
1535 if (!rail || !cloak)
1536 return ERROR_INVALID_PARAMETER;
1538 wStream* s = rail_pdu_init(5);
1542 WLog_ERR(TAG,
"rail_pdu_init failed!");
1543 return CHANNEL_RC_NO_MEMORY;
1546 Stream_Write_UINT32(s, cloak->windowId);
1547 Stream_Write_UINT8(s, cloak->cloak ? 1 : 0);
1548 return rail_send_pdu(rail, s, TS_RAIL_ORDER_CLOAK);
1554 return ERROR_INVALID_PARAMETER;
1557 if ((rail->channelFlags & TS_RAIL_ORDER_HANDSHAKE_EX_FLAGS_SNAP_ARRANGE_SUPPORTED) == 0)
1560 move.top = snap->top;
1561 move.left = snap->left;
1562 move.right = snap->right;
1563 move.bottom = snap->bottom;
1564 move.windowId = snap->windowId;
1565 return rail_send_client_window_move_order(rail, &move);
1568 wStream* s = rail_pdu_init(12);
1572 WLog_ERR(TAG,
"rail_pdu_init failed!");
1573 return CHANNEL_RC_NO_MEMORY;
1576 Stream_Write_UINT32(s, snap->windowId);
1577 Stream_Write_INT16(s, snap->left);
1578 Stream_Write_INT16(s, snap->top);
1579 Stream_Write_INT16(s, snap->right);
1580 Stream_Write_INT16(s, snap->bottom);
1581 return rail_send_pdu(rail, s, TS_RAIL_ORDER_SNAP_ARRANGE);
1584UINT rail_send_client_text_scale_order(
railPlugin* rail, UINT32 textScale)
1587 return ERROR_INVALID_PARAMETER;
1589 wStream* s = rail_pdu_init(4);
1593 WLog_ERR(TAG,
"rail_pdu_init failed!");
1594 return CHANNEL_RC_NO_MEMORY;
1597 Stream_Write_UINT32(s, textScale);
1598 return rail_send_pdu(rail, s, TS_RAIL_ORDER_TEXTSCALEINFO);
1601UINT rail_send_client_caret_blink_rate_order(
railPlugin* rail, UINT32 rate)
1604 return ERROR_INVALID_PARAMETER;
1606 wStream* s = rail_pdu_init(4);
1610 WLog_ERR(TAG,
"rail_pdu_init failed!");
1611 return CHANNEL_RC_NO_MEMORY;
1614 Stream_Write_UINT32(s, rate);
1615 return rail_send_pdu(rail, s, TS_RAIL_ORDER_CARETBLINKINFO);
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_rail_support_flags_to_string(UINT32 flags, char *buffer, size_t length)
Returns a stringified representation of RAIL support flags.