tf_freerdp.c

 
#include <freerdp/config.h>
 
#include <errno.h>
#include <stdio.h>
#include <string.h>
 
#include <freerdp/freerdp.h>
#include <freerdp/constants.h>
#include <freerdp/gdi/gdi.h>
#include <freerdp/streamdump.h>
#include <freerdp/utils/signal.h>
 
#include <freerdp/client/file.h>
#include <freerdp/client/cmdline.h>
#include <freerdp/client/cliprdr.h>
#include <freerdp/client/channels.h>
#include <freerdp/client/aad_helper.h>
#include <freerdp/channels/channels.h>
 
#include <winpr/crt.h>
#include <winpr/assert.h>
#include <winpr/synch.h>
#include <freerdp/log.h>
#include <freerdp/utils/helpers.h>
#include <freerdp/build-config.h>
#include <freerdp/version.h>
 
#include "tf_channels.h"
#include "tf_freerdp.h"
 
#define TAG CLIENT_TAG("sample")
 
/* This function is called whenever a new frame starts.
 * It can be used to reset invalidated areas. */
static BOOL tf_begin_paint(rdpContext* context)
{
  rdpGdi* gdi = nullptr;
 
  WINPR_ASSERT(context);
 
  gdi = context->gdi;
  WINPR_ASSERT(gdi);
  WINPR_ASSERT(gdi->primary);
  WINPR_ASSERT(gdi->primary->hdc);
  WINPR_ASSERT(gdi->primary->hdc->hwnd);
  WINPR_ASSERT(gdi->primary->hdc->hwnd->invalid);
  gdi->primary->hdc->hwnd->invalid->null = TRUE;
  return TRUE;
}
 
/* This function is called when the library completed composing a new
 * frame. Read out the changed areas and blit them to your output device.
 * The image buffer will have the format specified by gdi_init
 */
static BOOL tf_end_paint(rdpContext* context)
{
  rdpGdi* gdi = nullptr;
 
  WINPR_ASSERT(context);
 
  gdi = context->gdi;
  WINPR_ASSERT(gdi);
  WINPR_ASSERT(gdi->primary);
 
  HGDI_DC hdc = gdi->primary->hdc;
  WINPR_ASSERT(hdc);
  if (!hdc->hwnd)
    return TRUE;
 
  HGDI_WND hwnd = hdc->hwnd;
  WINPR_ASSERT(hwnd->invalid || (hwnd->ninvalid == 0));
 
  if (hwnd->invalid->null)
    return TRUE;
 
  return TRUE;
}
 
static BOOL tf_desktop_resize(rdpContext* context)
{
  rdpGdi* gdi = nullptr;
  rdpSettings* settings = nullptr;
 
  WINPR_ASSERT(context);
 
  settings = context->settings;
  WINPR_ASSERT(settings);
 
  gdi = context->gdi;
  return gdi_resize(gdi, freerdp_settings_get_uint32(settings, FreeRDP_DesktopWidth),
                    freerdp_settings_get_uint32(settings, FreeRDP_DesktopHeight));
}
 
/* This function is called to output a System BEEP */
static BOOL tf_play_sound(rdpContext* context, const PLAY_SOUND_UPDATE* play_sound)
{
  /* TODO: Implement */
  WINPR_UNUSED(context);
  WINPR_UNUSED(play_sound);
  return TRUE;
}
 
/* This function is called to update the keyboard indocator LED */
static BOOL tf_keyboard_set_indicators(rdpContext* context, UINT16 led_flags)
{
  /* TODO: Set local keyboard indicator LED status */
  WINPR_UNUSED(context);
  WINPR_UNUSED(led_flags);
  return TRUE;
}
 
/* This function is called to set the IME state */
static BOOL tf_keyboard_set_ime_status(rdpContext* context, UINT16 imeId, UINT32 imeState,
                                       UINT32 imeConvMode)
{
  if (!context)
    return FALSE;
 
  WLog_WARN(TAG,
            "KeyboardSetImeStatus(unitId=%04" PRIx16 ", imeState=%08" PRIx32
            ", imeConvMode=%08" PRIx32 ") ignored",
            imeId, imeState, imeConvMode);
  return TRUE;
}
 
/* Called before a connection is established.
 * Set all configuration options to support and load channels here. */
static BOOL tf_pre_connect(freerdp* instance)
{
  rdpSettings* settings = nullptr;
 
  WINPR_ASSERT(instance);
  WINPR_ASSERT(instance->context);
 
  settings = instance->context->settings;
  WINPR_ASSERT(settings);
 
  /* If the callbacks provide the PEM all certificate options can be extracted, otherwise
   * only the certificate fingerprint is available. */
  if (!freerdp_settings_set_bool(settings, FreeRDP_CertificateCallbackPreferPEM, TRUE))
    return FALSE;
 
  /* Optional OS identifier sent to server */
  if (!freerdp_settings_set_uint32(settings, FreeRDP_OsMajorType, OSMAJORTYPE_UNIX))
    return FALSE;
  if (!freerdp_settings_set_uint32(settings, FreeRDP_OsMinorType, OSMINORTYPE_NATIVE_XSERVER))
    return FALSE;
  /* OrderSupport is initialized at this point.
   * Only override it if you plan to implement custom order
   * callbacks or deactivate certain features. */
  /* Register the channel listeners.
   * They are required to set up / tear down channels if they are loaded. */
  if (PubSub_SubscribeChannelConnected(instance->context->pubSub,
                                       tf_OnChannelConnectedEventHandler) < 0)
    return FALSE;
  if (PubSub_SubscribeChannelDisconnected(instance->context->pubSub,
                                          tf_OnChannelDisconnectedEventHandler) < 0)
    return FALSE;
 
  /* TODO: Any code your client requires */
  return TRUE;
}
 
/* Called after a RDP connection was successfully established.
 * Settings might have changed during negotiation of client / server feature
 * support.
 *
 * Set up local framebuffers and paing callbacks.
 * If required, register pointer callbacks to change the local mouse cursor
 * when hovering over the RDP window
 */
static BOOL tf_post_connect(freerdp* instance)
{
  rdpContext* context = nullptr;
 
  if (!gdi_init(instance, PIXEL_FORMAT_XRGB32))
    return FALSE;
 
  context = instance->context;
  WINPR_ASSERT(context);
  WINPR_ASSERT(context->update);
 
  /* With this setting we disable all graphics processing in the library.
   *
   * This allows low resource (client) protocol parsing.
   */
  if (!freerdp_settings_set_bool(context->settings, FreeRDP_DeactivateClientDecoding, TRUE))
    return FALSE;
 
  context->update->BeginPaint = tf_begin_paint;
  context->update->EndPaint = tf_end_paint;
  context->update->PlaySound = tf_play_sound;
  context->update->DesktopResize = tf_desktop_resize;
  context->update->SetKeyboardIndicators = tf_keyboard_set_indicators;
  context->update->SetKeyboardImeStatus = tf_keyboard_set_ime_status;
  return TRUE;
}
 
/* This function is called whether a session ends by failure or success.
 * Clean up everything allocated by pre_connect and post_connect.
 */
static void tf_post_disconnect(freerdp* instance)
{
  tfContext* context = nullptr;
 
  if (!instance)
    return;
 
  if (!instance->context)
    return;
 
  context = (tfContext*)instance->context;
  PubSub_UnsubscribeChannelConnected(instance->context->pubSub,
                                     tf_OnChannelConnectedEventHandler);
  PubSub_UnsubscribeChannelDisconnected(instance->context->pubSub,
                                        tf_OnChannelDisconnectedEventHandler);
  gdi_free(instance);
  /* TODO : Clean up custom stuff */
  WINPR_UNUSED(context);
}
 
/* RDP main loop.
 * Connects RDP, loops while running and handles event and dispatch, cleans up
 * after the connection ends. */
static DWORD WINAPI tf_client_thread_proc(LPVOID arg)
{
  freerdp* instance = (freerdp*)arg;
  DWORD nCount = 0;
  DWORD status = 0;
  DWORD result = 0;
  HANDLE handles[MAXIMUM_WAIT_OBJECTS] = WINPR_C_ARRAY_INIT;
  BOOL rc = freerdp_connect(instance);
 
  WINPR_ASSERT(instance->context);
  WINPR_ASSERT(instance->context->settings);
  if (freerdp_settings_get_bool(instance->context->settings, FreeRDP_AuthenticationOnly))
  {
    result = freerdp_get_last_error(instance->context);
    freerdp_abort_connect_context(instance->context);
    WLog_ERR(TAG, "Authentication only, exit status 0x%08" PRIx32 "", result);
    goto disconnect;
  }
 
  if (!rc)
  {
    result = freerdp_get_last_error(instance->context);
    WLog_ERR(TAG, "connection failure 0x%08" PRIx32, result);
    goto disconnect;
  }
 
  while (!freerdp_shall_disconnect_context(instance->context))
  {
    nCount = freerdp_get_event_handles(instance->context, handles, ARRAYSIZE(handles));
 
    if (nCount == 0)
    {
      WLog_ERR(TAG, "freerdp_get_event_handles failed");
      break;
    }
 
    status = WaitForMultipleObjects(nCount, handles, FALSE, INFINITE);
 
    if (status == WAIT_FAILED)
    {
      WLog_ERR(TAG, "WaitForMultipleObjects failed with %" PRIu32 "", status);
      break;
    }
 
    if (!freerdp_check_event_handles(instance->context))
    {
      if (freerdp_get_last_error(instance->context) == FREERDP_ERROR_SUCCESS)
        WLog_ERR(TAG, "Failed to check FreeRDP event handles");
 
      break;
    }
  }
 
disconnect:
  freerdp_disconnect(instance);
  return result;
}
 
/* Optional global initializer.
 * Here we just register a signal handler to print out stack traces
 * if available. */
static BOOL tf_client_global_init(void)
{
  return freerdp_handle_signals() == 0;
}
 
/* Optional global tear down */
static void tf_client_global_uninit(void)
{
}
 
static int tf_logon_error_info(freerdp* instance, UINT32 data, UINT32 type)
{
  tfContext* tf = nullptr;
  const char* str_data = freerdp_get_logon_error_info_data(data);
  const char* str_type = freerdp_get_logon_error_info_type(type);
 
  if (!instance || !instance->context)
    return -1;
 
  tf = (tfContext*)instance->context;
  WLog_INFO(TAG, "Logon Error Info %s [%s]", str_data, str_type);
  WINPR_UNUSED(tf);
 
  return 1;
}
 
static BOOL tf_client_new(freerdp* instance, rdpContext* context)
{
  tfContext* tf = (tfContext*)context;
 
  if (!instance || !context)
    return FALSE;
 
  instance->PreConnect = tf_pre_connect;
  instance->PostConnect = tf_post_connect;
  instance->PostDisconnect = tf_post_disconnect;
  instance->LogonErrorInfo = tf_logon_error_info;
  instance->GetAccessToken = client_failsafe_get_access_token;
  /* TODO: Client display set up */
  WINPR_UNUSED(tf);
  return TRUE;
}
 
static void tf_client_free(freerdp* instance, rdpContext* context)
{
  tfContext* tf = (tfContext*)instance->context;
 
  if (!context)
    return;
 
  /* TODO: Client display tear down */
  WINPR_UNUSED(tf);
}
 
static int tf_client_start(rdpContext* context)
{
  /* TODO: Start client related stuff */
  WINPR_UNUSED(context);
  return 0;
}
 
static int tf_client_stop(rdpContext* context)
{
  /* TODO: Stop client related stuff */
  WINPR_UNUSED(context);
  return 0;
}
 
static int RdpClientEntry(RDP_CLIENT_ENTRY_POINTS* pEntryPoints)
{
  WINPR_ASSERT(pEntryPoints);
 
  ZeroMemory(pEntryPoints, sizeof(RDP_CLIENT_ENTRY_POINTS));
  pEntryPoints->Version = RDP_CLIENT_INTERFACE_VERSION;
  pEntryPoints->Size = sizeof(RDP_CLIENT_ENTRY_POINTS_V1);
  pEntryPoints->GlobalInit = tf_client_global_init;
  pEntryPoints->GlobalUninit = tf_client_global_uninit;
  pEntryPoints->ContextSize = sizeof(tfContext);
  pEntryPoints->ClientNew = tf_client_new;
  pEntryPoints->ClientFree = tf_client_free;
  pEntryPoints->ClientStart = tf_client_start;
  pEntryPoints->ClientStop = tf_client_stop;
  return 0;
}
 
int main(int argc, char* argv[])
{
  int rc = -1;
  RDP_CLIENT_ENTRY_POINTS clientEntryPoints = WINPR_C_ARRAY_INIT;
 
  /*
   * Set custom application details at first thing in main.
   * This will initialize a new namespace within FreeRDP and WinPR.
   * As a result all configuration files will be searched in different locations.
   *
   * The location is <prefix>/<vendor>/<product> or <prefix>/<vendor>/<product><version> for
   * config file search directories. An example for a system wide configuration file would be
   * /etc/FreeRDP/TFreeRDP3/ or ~/.config//FreeRDP/TFreeRDP3/ for user config files.
   *
   * Consult \ref GetKnownPath for <prefix> locations on different operating systems
   */
  if (!freerdp_setApplicationDetails(FREERDP_VENDOR_STRING, "TFreeRDP", FREERDP_VERSION_MAJOR))
    return -1;
 
  RdpClientEntry(&clientEntryPoints);
  rdpContext* context = freerdp_client_context_new(&clientEntryPoints);
 
  if (!context)
    goto fail;
 
  {
    const int status =
        freerdp_client_settings_parse_command_line(context->settings, argc, argv, FALSE);
    if (status)
    {
      rc = freerdp_client_settings_command_line_status_print(context->settings, status, argc,
                                                             argv);
      goto fail;
    }
  }
 
  if (!stream_dump_register_handlers(context, CONNECTION_STATE_MCS_CREATE_REQUEST, FALSE))
    goto fail;
 
  if (freerdp_client_start(context) != 0)
    goto fail;
 
  {
    const DWORD res = tf_client_thread_proc(context->instance);
    rc = (int)res;
  }
 
  if (freerdp_client_stop(context) != 0)
    rc = -1;
 
fail:
  freerdp_client_context_free(context);
  return rc;
}