/src/FreeRDP/channels/rail/client/rail_orders.c

Source
/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Remote Applications Integrated Locally (RAIL) Orders
 *
 * Copyright 2009 Marc-Andre Moreau <marcandre.moreau@gmail.com>
 * Copyright 2011 Roman Barabanov <romanbarabanov@gmail.com>
 * Copyright 2015 Thincast Technologies GmbH
 * Copyright 2015 DI (FH) Martin Haimberger <martin.haimberger@thincast.com>
 * Copyright 2017 Armin Novak <armin.novak@thincast.com>
 * Copyright 2017 Thincast Technologies GmbH
 *
 * 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.
 */

#include <freerdp/config.h>

#include <winpr/crt.h>
#include <winpr/cast.h>

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

#include "rail_orders.h"

static BOOL rail_is_feature_supported(const rdpContext* context, UINT32 featureMask);

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_pdu(railPlugin* rail, wStream* s, UINT16 orderType)
{
  char buffer[128] = WINPR_C_ARRAY_INIT;

  if (!rail || !s)
  {
    Stream_Free(s, TRUE);
    return ERROR_INVALID_PARAMETER;
  }

  const UINT16 orderLength = (UINT16)Stream_GetPosition(s);
  Stream_ResetPosition(s);
  if (!rail_write_pdu_header(s, orderType, orderLength))
    goto fail;
  if (!Stream_SetPosition(s, orderLength))
    goto fail;
  WLog_Print(rail->log, WLOG_DEBUG, "Sending %s PDU, length: %" PRIu16 "",
             rail_get_order_type_string_full(orderType, buffer, sizeof(buffer)), orderLength);
  return rail_send_channel_data(rail, s);

fail:
  Stream_Free(s, TRUE);
  return ERROR_INVALID_DATA;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_read_server_exec_result_order(wStream* s, RAIL_EXEC_RESULT_ORDER* execResult)
{
  if (!s || !execResult)
    return ERROR_INVALID_PARAMETER;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_EXEC_RESULT_ORDER_LENGTH))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT16(s, execResult->flags);      /* flags (2 bytes) */
  Stream_Read_UINT16(s, execResult->execResult); /* execResult (2 bytes) */
  Stream_Read_UINT32(s, execResult->rawResult);  /* rawResult (4 bytes) */
  Stream_Seek_UINT16(s);                         /* padding (2 bytes) */
  return rail_read_unicode_string(s, &execResult->exeOrFile)
             ? CHANNEL_RC_OK
             : ERROR_INTERNAL_ERROR; /* exeOrFile */
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_read_server_minmaxinfo_order(wStream* s, RAIL_MINMAXINFO_ORDER* minmaxinfo)
{
  if (!s || !minmaxinfo)
    return ERROR_INVALID_PARAMETER;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_MINMAXINFO_ORDER_LENGTH))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, minmaxinfo->windowId);      /* windowId (4 bytes) */
  Stream_Read_INT16(s, minmaxinfo->maxWidth);       /* maxWidth (2 bytes) */
  Stream_Read_INT16(s, minmaxinfo->maxHeight);      /* maxHeight (2 bytes) */
  Stream_Read_INT16(s, minmaxinfo->maxPosX);        /* maxPosX (2 bytes) */
  Stream_Read_INT16(s, minmaxinfo->maxPosY);        /* maxPosY (2 bytes) */
  Stream_Read_INT16(s, minmaxinfo->minTrackWidth);  /* minTrackWidth (2 bytes) */
  Stream_Read_INT16(s, minmaxinfo->minTrackHeight); /* minTrackHeight (2 bytes) */
  Stream_Read_INT16(s, minmaxinfo->maxTrackWidth);  /* maxTrackWidth (2 bytes) */
  Stream_Read_INT16(s, minmaxinfo->maxTrackHeight); /* maxTrackHeight (2 bytes) */
  return CHANNEL_RC_OK;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_read_server_localmovesize_order(wStream* s,
                                                 RAIL_LOCALMOVESIZE_ORDER* localMoveSize)
{
  UINT16 isMoveSizeStart = 0;

  if (!s || !localMoveSize)
    return ERROR_INVALID_PARAMETER;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_LOCALMOVESIZE_ORDER_LENGTH))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, localMoveSize->windowId); /* windowId (4 bytes) */
  Stream_Read_UINT16(s, isMoveSizeStart);         /* isMoveSizeStart (2 bytes) */
  localMoveSize->isMoveSizeStart = (isMoveSizeStart != 0);
  Stream_Read_UINT16(s, localMoveSize->moveSizeType); /* moveSizeType (2 bytes) */
  Stream_Read_INT16(s, localMoveSize->posX);          /* posX (2 bytes) */
  Stream_Read_INT16(s, localMoveSize->posY);          /* posY (2 bytes) */
  return CHANNEL_RC_OK;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_read_server_get_appid_resp_order(wStream* s,
                                                  RAIL_GET_APPID_RESP_ORDER* getAppidResp)
{
  if (!s || !getAppidResp)
    return ERROR_INVALID_PARAMETER;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_GET_APPID_RESP_ORDER_LENGTH))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, getAppidResp->windowId); /* windowId (4 bytes) */
  if (!Stream_Read_UTF16_String(
          s, getAppidResp->applicationId,
          ARRAYSIZE(getAppidResp->applicationId))) /* applicationId (260 UNICODE chars) */
    return ERROR_INVALID_DATA;

  if (_wcsnlen(getAppidResp->applicationId, ARRAYSIZE(getAppidResp->applicationId)) >=
      ARRAYSIZE(getAppidResp->applicationId))
    return ERROR_INVALID_DATA;

  return CHANNEL_RC_OK;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_read_langbar_info_order(wStream* s, RAIL_LANGBAR_INFO_ORDER* langbarInfo)
{
  if (!s || !langbarInfo)
    return ERROR_INVALID_PARAMETER;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_LANGBAR_INFO_ORDER_LENGTH))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, langbarInfo->languageBarStatus); /* languageBarStatus (4 bytes) */
  return CHANNEL_RC_OK;
}

static UINT rail_write_client_status_order(wStream* s, const RAIL_CLIENT_STATUS_ORDER* clientStatus)
{
  if (!s || !clientStatus)
    return ERROR_INVALID_PARAMETER;

  Stream_Write_UINT32(s, clientStatus->flags); /* flags (4 bytes) */
  return ERROR_SUCCESS;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_write_client_exec_order(wStream* s, UINT16 flags,
                                         const RAIL_UNICODE_STRING* exeOrFile,
                                         const RAIL_UNICODE_STRING* workingDir,
                                         const RAIL_UNICODE_STRING* arguments)
{
  UINT error = 0;

  if (!s || !exeOrFile || !workingDir || !arguments)
    return ERROR_INVALID_PARAMETER;

  /* [MS-RDPERP] 2.2.2.3.1 Client Execute PDU (TS_RAIL_ORDER_EXEC)
   * Check argument limits */
  if ((exeOrFile->length > 520) || (workingDir->length > 520) || (arguments->length > 16000))
  {
    WLog_ERR(TAG,
             "TS_RAIL_ORDER_EXEC argument limits exceeded: ExeOrFile=%" PRIu16
             " [max=520], WorkingDir=%" PRIu16 " [max=520], Arguments=%" PRIu16 " [max=16000]",
             exeOrFile->length, workingDir->length, arguments->length);
    return ERROR_BAD_ARGUMENTS;
  }

  Stream_Write_UINT16(s, flags);              /* flags (2 bytes) */
  Stream_Write_UINT16(s, exeOrFile->length);  /* exeOrFileLength (2 bytes) */
  Stream_Write_UINT16(s, workingDir->length); /* workingDirLength (2 bytes) */
  Stream_Write_UINT16(s, arguments->length);  /* argumentsLength (2 bytes) */

  if ((error = rail_write_unicode_string_value(s, exeOrFile)))
  {
    WLog_ERR(TAG, "rail_write_unicode_string_value failed with error %" PRIu32 "", error);
    return error;
  }

  if ((error = rail_write_unicode_string_value(s, workingDir)))
  {
    WLog_ERR(TAG, "rail_write_unicode_string_value failed with error %" PRIu32 "", error);
    return error;
  }

  if ((error = rail_write_unicode_string_value(s, arguments)))
  {
    WLog_ERR(TAG, "rail_write_unicode_string_value failed with error %" PRIu32 "", error);
    return error;
  }

  return error;
}

static UINT rail_write_client_activate_order(wStream* s, const RAIL_ACTIVATE_ORDER* activate)
{
  BYTE enabled = 0;

  if (!s || !activate)
    return ERROR_INVALID_PARAMETER;

  Stream_Write_UINT32(s, activate->windowId); /* windowId (4 bytes) */
  enabled = activate->enabled ? 1 : 0;
  Stream_Write_UINT8(s, enabled); /* enabled (1 byte) */
  return ERROR_SUCCESS;
}

static UINT rail_write_client_sysmenu_order(wStream* s, const RAIL_SYSMENU_ORDER* sysmenu)
{
  if (!s || !sysmenu)
    return ERROR_INVALID_PARAMETER;

  Stream_Write_UINT32(s, sysmenu->windowId); /* windowId (4 bytes) */
  Stream_Write_INT16(s, sysmenu->left);      /* left (2 bytes) */
  Stream_Write_INT16(s, sysmenu->top);       /* top (2 bytes) */
  return ERROR_SUCCESS;
}

static UINT rail_write_client_syscommand_order(wStream* s, const RAIL_SYSCOMMAND_ORDER* syscommand)
{
  if (!s || !syscommand)
    return ERROR_INVALID_PARAMETER;

  Stream_Write_UINT32(s, syscommand->windowId); /* windowId (4 bytes) */
  Stream_Write_UINT16(s, syscommand->command);  /* command (2 bytes) */
  return ERROR_SUCCESS;
}

static UINT rail_write_client_notify_event_order(wStream* s,
                                                 const RAIL_NOTIFY_EVENT_ORDER* notifyEvent)
{
  if (!s || !notifyEvent)
    return ERROR_INVALID_PARAMETER;

  Stream_Write_UINT32(s, notifyEvent->windowId);     /* windowId (4 bytes) */
  Stream_Write_UINT32(s, notifyEvent->notifyIconId); /* notifyIconId (4 bytes) */
  Stream_Write_UINT32(s, notifyEvent->message);      /* notifyIconId (4 bytes) */
  return ERROR_SUCCESS;
}

static UINT rail_write_client_window_move_order(wStream* s,
                                                const RAIL_WINDOW_MOVE_ORDER* windowMove)
{
  if (!s || !windowMove)
    return ERROR_INVALID_PARAMETER;

  Stream_Write_UINT32(s, windowMove->windowId); /* windowId (4 bytes) */
  Stream_Write_INT16(s, windowMove->left);      /* left (2 bytes) */
  Stream_Write_INT16(s, windowMove->top);       /* top (2 bytes) */
  Stream_Write_INT16(s, windowMove->right);     /* right (2 bytes) */
  Stream_Write_INT16(s, windowMove->bottom);    /* bottom (2 bytes) */
  return ERROR_SUCCESS;
}

static UINT rail_write_client_get_appid_req_order(wStream* s,
                                                  const RAIL_GET_APPID_REQ_ORDER* getAppidReq)
{
  if (!s || !getAppidReq)
    return ERROR_INVALID_PARAMETER;

  Stream_Write_UINT32(s, getAppidReq->windowId); /* windowId (4 bytes) */
  return ERROR_SUCCESS;
}

static UINT rail_write_langbar_info_order(wStream* s, const RAIL_LANGBAR_INFO_ORDER* langbarInfo)
{
  if (!s || !langbarInfo)
    return ERROR_INVALID_PARAMETER;

  Stream_Write_UINT32(s, langbarInfo->languageBarStatus); /* languageBarStatus (4 bytes) */
  return ERROR_SUCCESS;
}

static UINT rail_write_languageime_info_order(wStream* s,
                                              const RAIL_LANGUAGEIME_INFO_ORDER* langImeInfo)
{
  if (!s || !langImeInfo)
    return ERROR_INVALID_PARAMETER;

  Stream_Write_UINT32(s, langImeInfo->ProfileType);
  Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(UINT16, langImeInfo->LanguageID));
  Stream_Write(s, &langImeInfo->LanguageProfileCLSID, sizeof(langImeInfo->LanguageProfileCLSID));
  Stream_Write(s, &langImeInfo->ProfileGUID, sizeof(langImeInfo->ProfileGUID));
  Stream_Write_UINT32(s, langImeInfo->KeyboardLayout);
  return ERROR_SUCCESS;
}

static UINT rail_write_compartment_info_order(wStream* s,
                                              const RAIL_COMPARTMENT_INFO_ORDER* compartmentInfo)
{
  if (!s || !compartmentInfo)
    return ERROR_INVALID_PARAMETER;

  Stream_Write_UINT32(s, compartmentInfo->ImeState);
  Stream_Write_UINT32(s, compartmentInfo->ImeConvMode);
  Stream_Write_UINT32(s, compartmentInfo->ImeSentenceMode);
  Stream_Write_UINT32(s, compartmentInfo->KanaMode);
  return ERROR_SUCCESS;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_recv_handshake_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_HANDSHAKE_ORDER serverHandshake = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context || !s)
    return ERROR_INVALID_PARAMETER;

  if ((error = rail_read_handshake_order(s, &serverHandshake)))
  {
    WLog_ERR(TAG, "rail_read_handshake_order failed with error %" PRIu32 "!", error);
    return error;
  }

  rail->channelBuildNumber = serverHandshake.buildNumber;

  if (context->custom)
  {
    IFCALLRET(context->ServerHandshake, error, context, &serverHandshake);

    if (error)
      WLog_ERR(TAG, "context.ServerHandshake failed with error %" PRIu32 "", error);
  }

  return error;
}

static UINT rail_read_compartment_info_order(wStream* s,
                                             RAIL_COMPARTMENT_INFO_ORDER* compartmentInfo)
{
  if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_COMPARTMENT_INFO_ORDER_LENGTH))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, compartmentInfo->ImeState);        /* ImeState (4 bytes) */
  Stream_Read_UINT32(s, compartmentInfo->ImeConvMode);     /* ImeConvMode (4 bytes) */
  Stream_Read_UINT32(s, compartmentInfo->ImeSentenceMode); /* ImeSentenceMode (4 bytes) */
  Stream_Read_UINT32(s, compartmentInfo->KanaMode);        /* KANAMode (4 bytes) */
  return CHANNEL_RC_OK;
}

static UINT rail_recv_compartmentinfo_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_COMPARTMENT_INFO_ORDER pdu = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context || !s)
    return ERROR_INVALID_PARAMETER;

  if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED))
    return ERROR_BAD_CONFIGURATION;

  if ((error = rail_read_compartment_info_order(s, &pdu)))
    return error;

  if (context->custom)
  {
    IFCALLRET(context->ClientCompartmentInfo, error, context, &pdu);

    if (error)
      WLog_ERR(TAG, "context.ClientCompartmentInfo failed with error %" PRIu32 "", error);
  }

  return error;
}

BOOL rail_is_feature_supported(const rdpContext* context, UINT32 featureMask)
{
  UINT32 supported = 0;
  UINT32 masked = 0;

  if (!context || !context->settings)
    return FALSE;

  const UINT32 level =
      freerdp_settings_get_uint32(context->settings, FreeRDP_RemoteApplicationSupportLevel);
  const UINT32 mask =
      freerdp_settings_get_uint32(context->settings, FreeRDP_RemoteApplicationSupportMask);
  supported = level & mask;
  masked = (supported & featureMask);

  if (masked != featureMask)
  {
    char maskstr[256] = WINPR_C_ARRAY_INIT;
    char actualstr[256] = WINPR_C_ARRAY_INIT;

    WLog_WARN(TAG, "have %s, require %s",
              freerdp_rail_support_flags_to_string(supported, actualstr, sizeof(actualstr)),
              freerdp_rail_support_flags_to_string(featureMask, maskstr, sizeof(maskstr)));
    return FALSE;
  }

  return TRUE;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_recv_handshake_ex_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_HANDSHAKE_EX_ORDER serverHandshake = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!rail || !context || !s)
    return ERROR_INVALID_PARAMETER;

  if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_HANDSHAKE_EX_SUPPORTED))
    return ERROR_BAD_CONFIGURATION;

  if ((error = rail_read_handshake_ex_order(s, &serverHandshake)))
  {
    WLog_ERR(TAG, "rail_read_handshake_ex_order failed with error %" PRIu32 "!", error);
    return error;
  }

  rail->channelBuildNumber = serverHandshake.buildNumber;
  rail->channelFlags = serverHandshake.railHandshakeFlags;

  {
    char buffer[192] = WINPR_C_ARRAY_INIT;
    WLog_DBG(TAG, "HandshakeFlags=%s [buildNumber=0x%08" PRIx32 "]",
             rail_handshake_ex_flags_to_string(rail->channelFlags, buffer, sizeof(buffer)),
             rail->channelBuildNumber);
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerHandshakeEx, error, context, &serverHandshake);

    if (error)
      WLog_ERR(TAG, "context.ServerHandshakeEx failed with error %" PRIu32 "", error);
  }

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_recv_exec_result_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_EXEC_RESULT_ORDER execResult = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context || !s)
    return ERROR_INVALID_PARAMETER;

  if ((error = rail_read_server_exec_result_order(s, &execResult)))
  {
    WLog_ERR(TAG, "rail_read_server_exec_result_order failed with error %" PRIu32 "!", error);
    goto fail;
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerExecuteResult, error, context, &execResult);

    if (error)
      WLog_ERR(TAG, "context.ServerExecuteResult failed with error %" PRIu32 "", error);
  }

fail:
  rail_unicode_string_free(&execResult.exeOrFile);
  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_recv_server_sysparam_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);

  if (!context || !s)
    return ERROR_INVALID_PARAMETER;

  const BOOL extendedSpiSupported = rail_is_extended_spi_supported(rail->channelFlags);
  RAIL_SYSPARAM_ORDER sysparam = WINPR_C_ARRAY_INIT;
  UINT error = rail_read_sysparam_order(s, &sysparam, extendedSpiSupported);
  if (error)
  {
    WLog_ERR(TAG, "rail_read_sysparam_order failed with error %" PRIu32 "!", error);
    goto fail;
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerSystemParam, error, context, &sysparam);

    if (error)
      WLog_ERR(TAG, "context.ServerSystemParam failed with error %" PRIu32 "", error);
  }
fail:
  rail_unicode_string_free(&sysparam.highContrast.colorScheme);

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_recv_server_minmaxinfo_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_MINMAXINFO_ORDER minMaxInfo = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context || !s)
    return ERROR_INVALID_PARAMETER;

  if ((error = rail_read_server_minmaxinfo_order(s, &minMaxInfo)))
  {
    WLog_ERR(TAG, "rail_read_server_minmaxinfo_order failed with error %" PRIu32 "!", error);
    return error;
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerMinMaxInfo, error, context, &minMaxInfo);

    if (error)
      WLog_ERR(TAG, "context.ServerMinMaxInfo failed with error %" PRIu32 "", error);
  }

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_recv_server_localmovesize_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_LOCALMOVESIZE_ORDER localMoveSize = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context || !s)
    return ERROR_INVALID_PARAMETER;

  if ((error = rail_read_server_localmovesize_order(s, &localMoveSize)))
  {
    WLog_ERR(TAG, "rail_read_server_localmovesize_order failed with error %" PRIu32 "!", error);
    return error;
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerLocalMoveSize, error, context, &localMoveSize);

    if (error)
      WLog_ERR(TAG, "context.ServerLocalMoveSize failed with error %" PRIu32 "", error);
  }

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_recv_server_get_appid_resp_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_GET_APPID_RESP_ORDER getAppIdResp = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context || !s)
    return ERROR_INVALID_PARAMETER;

  if ((error = rail_read_server_get_appid_resp_order(s, &getAppIdResp)))
  {
    WLog_ERR(TAG, "rail_read_server_get_appid_resp_order failed with error %" PRIu32 "!",
             error);
    return error;
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerGetAppIdResponse, error, context, &getAppIdResp);

    if (error)
      WLog_ERR(TAG, "context.ServerGetAppIdResponse failed with error %" PRIu32 "", error);
  }

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
static UINT rail_recv_langbar_info_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_LANGBAR_INFO_ORDER langBarInfo = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context)
    return ERROR_INVALID_PARAMETER;

  if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED))
    return ERROR_BAD_CONFIGURATION;

  if ((error = rail_read_langbar_info_order(s, &langBarInfo)))
  {
    WLog_ERR(TAG, "rail_read_langbar_info_order failed with error %" PRIu32 "!", error);
    return error;
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerLanguageBarInfo, error, context, &langBarInfo);

    if (error)
      WLog_ERR(TAG, "context.ServerLanguageBarInfo failed with error %" PRIu32 "", error);
  }

  return error;
}

static UINT rail_read_taskbar_info_order(wStream* s, RAIL_TASKBAR_INFO_ORDER* taskbarInfo)
{
  if (!s || !taskbarInfo)
    return ERROR_INVALID_PARAMETER;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_TASKBAR_INFO_ORDER_LENGTH))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, taskbarInfo->TaskbarMessage);
  Stream_Read_UINT32(s, taskbarInfo->WindowIdTab);
  Stream_Read_UINT32(s, taskbarInfo->Body);
  return CHANNEL_RC_OK;
}

static UINT rail_recv_taskbar_info_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_TASKBAR_INFO_ORDER taskBarInfo = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context)
    return ERROR_INVALID_PARAMETER;

  /* 2.2.2.14.1 Taskbar Tab Info PDU (TS_RAIL_ORDER_TASKBARINFO)
   * server -> client message only supported if announced. */
  if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_SHELL_INTEGRATION_SUPPORTED))
    return ERROR_BAD_CONFIGURATION;

  if ((error = rail_read_taskbar_info_order(s, &taskBarInfo)))
  {
    WLog_ERR(TAG, "rail_read_langbar_info_order failed with error %" PRIu32 "!", error);
    return error;
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerTaskBarInfo, error, context, &taskBarInfo);

    if (error)
      WLog_ERR(TAG, "context.ServerTaskBarInfo failed with error %" PRIu32 "", error);
  }

  return error;
}

static UINT rail_read_zorder_sync_order(wStream* s, RAIL_ZORDER_SYNC* zorder)
{
  if (!s || !zorder)
    return ERROR_INVALID_PARAMETER;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_Z_ORDER_SYNC_ORDER_LENGTH))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, zorder->windowIdMarker);
  return CHANNEL_RC_OK;
}

static UINT rail_recv_zorder_sync_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_ZORDER_SYNC zorder = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context)
    return ERROR_INVALID_PARAMETER;

  if ((rail->clientStatus.flags & TS_RAIL_CLIENTSTATUS_ZORDER_SYNC) == 0)
    return ERROR_BAD_CONFIGURATION;

  if ((error = rail_read_zorder_sync_order(s, &zorder)))
  {
    WLog_ERR(TAG, "rail_read_zorder_sync_order failed with error %" PRIu32 "!", error);
    return error;
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerZOrderSync, error, context, &zorder);

    if (error)
      WLog_ERR(TAG, "context.ServerZOrderSync failed with error %" PRIu32 "", error);
  }

  return error;
}

static UINT rail_read_cloak_order(wStream* s, RAIL_CLOAK* cloak)
{
  BYTE cloaked = 0;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_CLOAK_ORDER_LENGTH))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, cloak->windowId); /* WindowId (4 bytes) */
  Stream_Read_UINT8(s, cloaked);          /* Cloaked (1 byte) */
  cloak->cloak = (cloaked != 0);
  return CHANNEL_RC_OK;
}

static UINT rail_recv_cloak_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_CLOAK cloak = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context)
    return ERROR_INVALID_PARAMETER;

  /* 2.2.2.12.1 Window Cloak State Change PDU (TS_RAIL_ORDER_CLOAK)
   * server -> client message only supported if announced. */
  if ((rail->clientStatus.flags & TS_RAIL_CLIENTSTATUS_BIDIRECTIONAL_CLOAK_SUPPORTED) == 0)
    return ERROR_INVALID_DATA;

  if ((error = rail_read_cloak_order(s, &cloak)))
  {
    WLog_ERR(TAG, "rail_read_zorder_sync_order failed with error %" PRIu32 "!", error);
    return error;
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerCloak, error, context, &cloak);

    if (error)
      WLog_ERR(TAG, "context.ServerZOrderSync failed with error %" PRIu32 "", error);
  }

  return error;
}

static UINT rail_read_power_display_request_order(wStream* s, RAIL_POWER_DISPLAY_REQUEST* power)
{
  UINT32 active = 0;

  if (!s || !power)
    return ERROR_INVALID_PARAMETER;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, RAIL_POWER_DISPLAY_REQUEST_ORDER_LENGTH))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, active);
  power->active = active != 0;
  return CHANNEL_RC_OK;
}

static UINT rail_recv_power_display_request_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_POWER_DISPLAY_REQUEST power = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context)
    return ERROR_INVALID_PARAMETER;

  /* 2.2.2.13.1 Power Display Request PDU(TS_RAIL_ORDER_POWER_DISPLAY_REQUEST)
   */
  if ((rail->clientStatus.flags & TS_RAIL_CLIENTSTATUS_POWER_DISPLAY_REQUEST_SUPPORTED) == 0)
    return ERROR_BAD_CONFIGURATION;

  if ((error = rail_read_power_display_request_order(s, &power)))
  {
    WLog_ERR(TAG, "rail_read_zorder_sync_order failed with error %" PRIu32 "!", error);
    return error;
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerPowerDisplayRequest, error, context, &power);

    if (error)
      WLog_ERR(TAG, "context.ServerPowerDisplayRequest failed with error %" PRIu32 "", error);
  }

  return error;
}

static UINT rail_read_get_application_id_extended_response_order(wStream* s,
                                                                 RAIL_GET_APPID_RESP_EX* id)
{
  if (!s || !id)
    return ERROR_INVALID_PARAMETER;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, id->windowID);

  if (!Stream_Read_UTF16_String(s, id->applicationID, ARRAYSIZE(id->applicationID)))
    return ERROR_INVALID_DATA;

  if (_wcsnlen(id->applicationID, ARRAYSIZE(id->applicationID)) >= ARRAYSIZE(id->applicationID))
    return ERROR_INVALID_DATA;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, id->processId);

  if (!Stream_Read_UTF16_String(s, id->processImageName, ARRAYSIZE(id->processImageName)))
    return ERROR_INVALID_DATA;

  if (_wcsnlen(id->processImageName, ARRAYSIZE(id->processImageName)) >=
      ARRAYSIZE(id->processImageName))
    return ERROR_INVALID_DATA;

  return CHANNEL_RC_OK;
}

static UINT rail_recv_get_application_id_extended_response_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  RAIL_GET_APPID_RESP_EX id = WINPR_C_ARRAY_INIT;
  UINT error = 0;

  if (!context)
    return ERROR_INVALID_PARAMETER;

  if ((error = rail_read_get_application_id_extended_response_order(s, &id)))
  {
    WLog_ERR(TAG,
             "rail_read_get_application_id_extended_response_order failed with error %" PRIu32
             "!",
             error);
    return error;
  }

  if (context->custom)
  {
    IFCALLRET(context->ServerGetAppidResponseExtended, error, context, &id);

    if (error)
      WLog_ERR(TAG, "context.ServerGetAppidResponseExtended failed with error %" PRIu32 "",
               error);
  }

  return error;
}

static UINT rail_read_textscaleinfo_order(wStream* s, UINT32* pTextScaleFactor)
{
  WINPR_ASSERT(pTextScaleFactor);

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, *pTextScaleFactor);
  return CHANNEL_RC_OK;
}

static UINT rail_recv_textscaleinfo_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  UINT32 TextScaleFactor = 0;
  UINT error = 0;

  if (!context)
    return ERROR_INVALID_PARAMETER;

  if ((error = rail_read_textscaleinfo_order(s, &TextScaleFactor)))
    return error;

  if (context->custom)
  {
    IFCALLRET(context->ClientTextScale, error, context, TextScaleFactor);

    if (error)
      WLog_ERR(TAG, "context.ClientTextScale failed with error %" PRIu32 "", error);
  }

  return error;
}

static UINT rail_read_caretblinkinfo_order(wStream* s, UINT32* pCaretBlinkRate)
{
  WINPR_ASSERT(pCaretBlinkRate);

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
    return ERROR_INVALID_DATA;

  Stream_Read_UINT32(s, *pCaretBlinkRate);
  return CHANNEL_RC_OK;
}

static UINT rail_recv_caretblinkinfo_order(railPlugin* rail, wStream* s)
{
  RailClientContext* context = rail_get_client_interface(rail);
  UINT32 CaretBlinkRate = 0;
  UINT error = 0;

  if (!context)
    return ERROR_INVALID_PARAMETER;
  if ((error = rail_read_caretblinkinfo_order(s, &CaretBlinkRate)))
    return error;

  if (context->custom)
  {
    IFCALLRET(context->ClientCaretBlinkRate, error, context, CaretBlinkRate);

    if (error)
      WLog_ERR(TAG, "context.ClientCaretBlinkRate failed with error %" PRIu32 "", error);
  }

  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_order_recv(LPVOID userdata, wStream* s)
{
  char buffer[128] = WINPR_C_ARRAY_INIT;
  railPlugin* rail = userdata;
  UINT16 orderType = 0;
  UINT16 orderLength = 0;
  UINT error = CHANNEL_RC_OK;

  if (!rail || !s)
  {
    error = ERROR_INVALID_PARAMETER;
    goto fail;
  }

  if ((error = rail_read_pdu_header(s, &orderType, &orderLength)))
  {
    WLog_ERR(TAG, "rail_read_pdu_header failed with error %" PRIu32 "!", error);
    error = ERROR_INVALID_DATA;
    goto fail;
  }

  WLog_Print(rail->log, WLOG_DEBUG, "Received %s PDU, length:%" PRIu16 "",
             rail_get_order_type_string_full(orderType, buffer, sizeof(buffer)), orderLength);

  switch (orderType)
  {
    case TS_RAIL_ORDER_HANDSHAKE:
      error = rail_recv_handshake_order(rail, s);
      break;

    case TS_RAIL_ORDER_COMPARTMENTINFO:
      error = rail_recv_compartmentinfo_order(rail, s);
      break;

    case TS_RAIL_ORDER_HANDSHAKE_EX:
      error = rail_recv_handshake_ex_order(rail, s);
      break;

    case TS_RAIL_ORDER_EXEC_RESULT:
      error = rail_recv_exec_result_order(rail, s);
      break;

    case TS_RAIL_ORDER_SYSPARAM:
      error = rail_recv_server_sysparam_order(rail, s);
      break;

    case TS_RAIL_ORDER_MINMAXINFO:
      error = rail_recv_server_minmaxinfo_order(rail, s);
      break;

    case TS_RAIL_ORDER_LOCALMOVESIZE:
      error = rail_recv_server_localmovesize_order(rail, s);
      break;

    case TS_RAIL_ORDER_GET_APPID_RESP:
      error = rail_recv_server_get_appid_resp_order(rail, s);
      break;

    case TS_RAIL_ORDER_LANGBARINFO:
      error = rail_recv_langbar_info_order(rail, s);
      break;

    case TS_RAIL_ORDER_TASKBARINFO:
      error = rail_recv_taskbar_info_order(rail, s);
      break;

    case TS_RAIL_ORDER_ZORDER_SYNC:
      error = rail_recv_zorder_sync_order(rail, s);
      break;

    case TS_RAIL_ORDER_CLOAK:
      error = rail_recv_cloak_order(rail, s);
      break;

    case TS_RAIL_ORDER_POWER_DISPLAY_REQUEST:
      error = rail_recv_power_display_request_order(rail, s);
      break;

    case TS_RAIL_ORDER_GET_APPID_RESP_EX:
      error = rail_recv_get_application_id_extended_response_order(rail, s);
      break;

    case TS_RAIL_ORDER_TEXTSCALEINFO:
      error = rail_recv_textscaleinfo_order(rail, s);
      break;

    case TS_RAIL_ORDER_CARETBLINKINFO:
      error = rail_recv_caretblinkinfo_order(rail, s);
      break;

    default:
      WLog_ERR(TAG, "Unknown RAIL PDU %s received.",
               rail_get_order_type_string_full(orderType, buffer, sizeof(buffer)));
      return ERROR_INVALID_DATA;
  }

  if (error == ERROR_BAD_CONFIGURATION)
  {
    char ebuffer[128] = WINPR_C_ARRAY_INIT;
    WLog_Print(rail->log, WLOG_WARN,
               "%s - SERVER BUG: The support for this feature was not announced!",
               rail_get_order_type_string_full(orderType, ebuffer, sizeof(ebuffer)));

    if (freerdp_settings_get_bool(rail->rdpcontext->settings,
                                  FreeRDP_AllowUnanouncedOrdersFromServer))
      error = CHANNEL_RC_OK;
  }
  if (error != CHANNEL_RC_OK)
  {
    char ebuffer[128] = WINPR_C_ARRAY_INIT;
    WLog_Print(rail->log, WLOG_ERROR, "Failed to process rail %s PDU, length:%" PRIu16 "",
               rail_get_order_type_string_full(orderType, ebuffer, sizeof(ebuffer)),
               orderLength);
  }

fail:
  Stream_Free(s, TRUE);
  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_handshake_order(railPlugin* rail, const RAIL_HANDSHAKE_ORDER* handshake)
{
  if (!rail || !handshake)
    return ERROR_INVALID_PARAMETER;

  wStream* s = rail_pdu_init(RAIL_HANDSHAKE_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  rail_write_handshake_order(s, handshake);
  return rail_send_pdu(rail, s, TS_RAIL_ORDER_HANDSHAKE);
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_handshake_ex_order(railPlugin* rail, const RAIL_HANDSHAKE_EX_ORDER* handshakeEx)
{
  if (!rail || !handshakeEx)
    return ERROR_INVALID_PARAMETER;

  wStream* s = rail_pdu_init(RAIL_HANDSHAKE_EX_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  rail_write_handshake_ex_order(s, handshakeEx);
  return rail_send_pdu(rail, s, TS_RAIL_ORDER_HANDSHAKE_EX);
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_client_status_order(railPlugin* rail, const RAIL_CLIENT_STATUS_ORDER* clientStatus)
{
  wStream* s = nullptr;
  UINT error = 0;

  if (!rail || !clientStatus)
    return ERROR_INVALID_PARAMETER;

  rail->clientStatus = *clientStatus;
  s = rail_pdu_init(RAIL_CLIENT_STATUS_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  error = rail_write_client_status_order(s, clientStatus);

  if (ERROR_SUCCESS != error)
  {

    Stream_Free(s, TRUE);
    return error;
  }

  return rail_send_pdu(rail, s, TS_RAIL_ORDER_CLIENTSTATUS);
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_client_exec_order(railPlugin* rail, UINT16 flags,
                                 const RAIL_UNICODE_STRING* exeOrFile,
                                 const RAIL_UNICODE_STRING* workingDir,
                                 const RAIL_UNICODE_STRING* arguments)
{
  wStream* s = nullptr;
  UINT error = 0;
  size_t length = 0;

  if (!rail || !exeOrFile || !workingDir || !arguments)
    return ERROR_INVALID_PARAMETER;

  length = RAIL_EXEC_ORDER_LENGTH + exeOrFile->length + workingDir->length + arguments->length;
  s = rail_pdu_init(length);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  if ((error = rail_write_client_exec_order(s, flags, exeOrFile, workingDir, arguments)))
  {
    WLog_ERR(TAG, "rail_write_client_exec_order failed with error %" PRIu32 "!", error);
    goto out;
  }

  return rail_send_pdu(rail, s, TS_RAIL_ORDER_EXEC);

out:
  Stream_Free(s, TRUE);
  return error;
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_client_activate_order(railPlugin* rail, const RAIL_ACTIVATE_ORDER* activate)
{
  wStream* s = nullptr;
  UINT error = 0;

  if (!rail || !activate)
    return ERROR_INVALID_PARAMETER;

  s = rail_pdu_init(RAIL_ACTIVATE_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  error = rail_write_client_activate_order(s, activate);

  if (ERROR_SUCCESS != error)
  {

    Stream_Free(s, TRUE);
    return error;
  }

  return rail_send_pdu(rail, s, TS_RAIL_ORDER_ACTIVATE);
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_client_sysmenu_order(railPlugin* rail, const RAIL_SYSMENU_ORDER* sysmenu)
{
  wStream* s = nullptr;
  UINT error = 0;

  if (!rail || !sysmenu)
    return ERROR_INVALID_PARAMETER;

  s = rail_pdu_init(RAIL_SYSMENU_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  error = rail_write_client_sysmenu_order(s, sysmenu);

  if (ERROR_SUCCESS != error)
  {

    Stream_Free(s, TRUE);
    return error;
  }

  return rail_send_pdu(rail, s, TS_RAIL_ORDER_SYSMENU);
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_client_syscommand_order(railPlugin* rail, const RAIL_SYSCOMMAND_ORDER* syscommand)
{
  wStream* s = nullptr;
  UINT error = 0;

  if (!rail || !syscommand)
    return ERROR_INVALID_PARAMETER;

  s = rail_pdu_init(RAIL_SYSCOMMAND_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  error = rail_write_client_syscommand_order(s, syscommand);

  if (ERROR_SUCCESS != error)
  {

    Stream_Free(s, TRUE);
    return error;
  }

  return rail_send_pdu(rail, s, TS_RAIL_ORDER_SYSCOMMAND);
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_client_notify_event_order(railPlugin* rail,
                                         const RAIL_NOTIFY_EVENT_ORDER* notifyEvent)
{
  wStream* s = nullptr;
  UINT error = 0;

  if (!rail || !notifyEvent)
    return ERROR_INVALID_PARAMETER;

  s = rail_pdu_init(RAIL_NOTIFY_EVENT_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  error = rail_write_client_notify_event_order(s, notifyEvent);

  if (ERROR_SUCCESS != error)
  {

    Stream_Free(s, TRUE);
    return error;
  }

  return rail_send_pdu(rail, s, TS_RAIL_ORDER_NOTIFY_EVENT);
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_client_window_move_order(railPlugin* rail, const RAIL_WINDOW_MOVE_ORDER* windowMove)
{
  wStream* s = nullptr;
  UINT error = 0;

  if (!rail || !windowMove)
    return ERROR_INVALID_PARAMETER;

  s = rail_pdu_init(RAIL_WINDOW_MOVE_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  error = rail_write_client_window_move_order(s, windowMove);

  if (ERROR_SUCCESS != error)
  {

    Stream_Free(s, TRUE);
    return error;
  }

  return rail_send_pdu(rail, s, TS_RAIL_ORDER_WINDOWMOVE);
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_client_get_appid_req_order(railPlugin* rail,
                                          const RAIL_GET_APPID_REQ_ORDER* getAppIdReq)
{
  wStream* s = nullptr;
  UINT error = 0;

  if (!rail || !getAppIdReq)
    return ERROR_INVALID_PARAMETER;

  s = rail_pdu_init(RAIL_GET_APPID_REQ_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  error = rail_write_client_get_appid_req_order(s, getAppIdReq);

  if (ERROR_SUCCESS != error)
  {

    Stream_Free(s, TRUE);
    return error;
  }
  return rail_send_pdu(rail, s, TS_RAIL_ORDER_GET_APPID_REQ);
}

/**
 * Function description
 *
 * @return 0 on success, otherwise a Win32 error code
 */
UINT rail_send_client_langbar_info_order(railPlugin* rail,
                                         const RAIL_LANGBAR_INFO_ORDER* langBarInfo)
{
  wStream* s = nullptr;
  UINT error = 0;

  if (!rail || !langBarInfo)
    return ERROR_INVALID_PARAMETER;

  if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED))
    return ERROR_BAD_CONFIGURATION;

  s = rail_pdu_init(RAIL_LANGBAR_INFO_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  error = rail_write_langbar_info_order(s, langBarInfo);

  if (ERROR_SUCCESS != error)
  {

    Stream_Free(s, TRUE);
    return error;
  }
  return rail_send_pdu(rail, s, TS_RAIL_ORDER_LANGBARINFO);
}

UINT rail_send_client_languageime_info_order(railPlugin* rail,
                                             const RAIL_LANGUAGEIME_INFO_ORDER* langImeInfo)
{
  wStream* s = nullptr;
  UINT error = 0;

  if (!rail || !langImeInfo)
    return ERROR_INVALID_PARAMETER;

  if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED))
    return ERROR_BAD_CONFIGURATION;

  s = rail_pdu_init(RAIL_LANGUAGEIME_INFO_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  error = rail_write_languageime_info_order(s, langImeInfo);

  if (ERROR_SUCCESS != error)
  {

    Stream_Free(s, TRUE);
    return error;
  }
  return rail_send_pdu(rail, s, TS_RAIL_ORDER_LANGUAGEIMEINFO);
}

UINT rail_send_client_compartment_info_order(railPlugin* rail,
                                             const RAIL_COMPARTMENT_INFO_ORDER* compartmentInfo)
{
  wStream* s = nullptr;
  UINT error = 0;

  if (!rail || !compartmentInfo)
    return ERROR_INVALID_PARAMETER;

  if (!rail_is_feature_supported(rail->rdpcontext, RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED))
    return ERROR_BAD_CONFIGURATION;

  s = rail_pdu_init(RAIL_COMPARTMENT_INFO_ORDER_LENGTH);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  error = rail_write_compartment_info_order(s, compartmentInfo);

  if (ERROR_SUCCESS != error)
  {
    Stream_Free(s, TRUE);
    return error;
  }
  return rail_send_pdu(rail, s, TS_RAIL_ORDER_COMPARTMENTINFO);
}

UINT rail_send_client_cloak_order(railPlugin* rail, const RAIL_CLOAK* cloak)
{
  if (!rail || !cloak)
    return ERROR_INVALID_PARAMETER;

  wStream* s = rail_pdu_init(5);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  Stream_Write_UINT32(s, cloak->windowId);
  Stream_Write_UINT8(s, cloak->cloak ? 1 : 0);
  return rail_send_pdu(rail, s, TS_RAIL_ORDER_CLOAK);
}

UINT rail_send_client_snap_arrange_order(railPlugin* rail, const RAIL_SNAP_ARRANGE* snap)
{
  if (!rail)
    return ERROR_INVALID_PARAMETER;

  /* 2.2.2.7.5 Client Window Snap PDU (TS_RAIL_ORDER_SNAP_ARRANGE) */
  if ((rail->channelFlags & TS_RAIL_ORDER_HANDSHAKE_EX_FLAGS_SNAP_ARRANGE_SUPPORTED) == 0)
  {
    RAIL_WINDOW_MOVE_ORDER move = WINPR_C_ARRAY_INIT;
    move.top = snap->top;
    move.left = snap->left;
    move.right = snap->right;
    move.bottom = snap->bottom;
    move.windowId = snap->windowId;
    return rail_send_client_window_move_order(rail, &move);
  }

  wStream* s = rail_pdu_init(12);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  Stream_Write_UINT32(s, snap->windowId);
  Stream_Write_INT16(s, snap->left);
  Stream_Write_INT16(s, snap->top);
  Stream_Write_INT16(s, snap->right);
  Stream_Write_INT16(s, snap->bottom);
  return rail_send_pdu(rail, s, TS_RAIL_ORDER_SNAP_ARRANGE);
}

UINT rail_send_client_text_scale_order(railPlugin* rail, UINT32 textScale)
{
  if (!rail)
    return ERROR_INVALID_PARAMETER;

  wStream* s = rail_pdu_init(4);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  Stream_Write_UINT32(s, textScale);
  return rail_send_pdu(rail, s, TS_RAIL_ORDER_TEXTSCALEINFO);
}

UINT rail_send_client_caret_blink_rate_order(railPlugin* rail, UINT32 rate)
{
  if (!rail)
    return ERROR_INVALID_PARAMETER;

  wStream* s = rail_pdu_init(4);

  if (!s)
  {
    WLog_ERR(TAG, "rail_pdu_init failed!");
    return CHANNEL_RC_NO_MEMORY;
  }

  Stream_Write_UINT32(s, rate);
  return rail_send_pdu(rail, s, TS_RAIL_ORDER_CARETBLINKINFO);
}

Coverage Report

Created: 2026-10-15 06:31