20#include <freerdp/config.h>
26#include <winpr/cast.h>
27#include <winpr/assert.h>
28#include <winpr/wlog.h>
29#include <winpr/print.h>
30#include <winpr/sysinfo.h>
32#include <freerdp/client/rail.h>
38#include <freerdp/log.h>
41static const char* error_code2str(UINT32 code)
48 EVCASE(RAIL_EXEC_S_OK);
49 EVCASE(RAIL_EXEC_E_HOOK_NOT_LOADED);
50 EVCASE(RAIL_EXEC_E_DECODE_FAILED);
51 EVCASE(RAIL_EXEC_E_NOT_IN_ALLOWLIST);
52 EVCASE(RAIL_EXEC_E_FILE_NOT_FOUND);
53 EVCASE(RAIL_EXEC_E_FAIL);
54 EVCASE(RAIL_EXEC_E_SESSION_LOCKED);
56 return "RAIL_EXEC_E_UNKNOWN";
62static const char* movetype2str(UINT32 code)
71 EVCASE(RAIL_WMSZ_LEFT);
72 EVCASE(RAIL_WMSZ_RIGHT);
73 EVCASE(RAIL_WMSZ_TOP);
74 EVCASE(RAIL_WMSZ_TOPLEFT);
75 EVCASE(RAIL_WMSZ_TOPRIGHT);
76 EVCASE(RAIL_WMSZ_BOTTOM);
77 EVCASE(RAIL_WMSZ_BOTTOMLEFT);
78 EVCASE(RAIL_WMSZ_BOTTOMRIGHT);
79 EVCASE(RAIL_WMSZ_MOVE);
80 EVCASE(RAIL_WMSZ_KEYMOVE);
81 EVCASE(RAIL_WMSZ_KEYSIZE);
83 return "RAIL_WMSZ_INVALID";
93typedef struct xf_rail_icon xfRailIcon;
95struct xf_rail_icon_cache
99 UINT32 numCacheEntries;
107} rail_paint_fn_arg_t;
109BOOL xf_rail_enable_remoteapp_mode(xfContext* xfc)
112 if (!xfc->remote_app)
114 rdpGdi* gdi = xfc->common.context.gdi;
117 const BOOL old = gdi->suppressOutput;
118 gdi->suppressOutput = TRUE;
119 xfc->remote_app = TRUE;
120 xfc->drawable = xf_CreateDummyWindow(xfc);
121 xf_DestroyDesktopWindow(xfc, xfc->window);
122 xfc->window =
nullptr;
124 gdi->suppressOutput = old;
129BOOL xf_rail_disable_remoteapp_mode(xfContext* xfc)
134 rdpGdi* gdi = xfc->common.context.gdi;
137 const BOOL old = gdi->suppressOutput;
138 gdi->suppressOutput = TRUE;
140 xfc->remote_app = FALSE;
141 xf_DestroyDummyWindow(xfc, xfc->drawable);
142 xf_destroy_window(xfc);
143 xf_create_window(xfc);
144 xf_create_image(xfc);
146 gdi->suppressOutput = old;
152static BOOL xf_rail_select_workarea_events(xfContext* xfc)
156 XWindowAttributes attributes = WINPR_C_ARRAY_INIT;
157 const Window root = DefaultRootWindow(xfc->display);
158 const int rc = LogDynAndXGetWindowAttributes(xfc->log, xfc->display, root, &attributes);
162 LogDynAndXSelectInput(xfc->log, xfc->display, root,
163 attributes.your_event_mask | PropertyChangeMask);
168static BOOL xf_rail_get_workarea(xfContext* xfc, xfWorkArea* workArea)
171 WINPR_ASSERT(workArea);
174 const xfWorkArea saved = xfc->workArea;
175 const BOOL rc = xf_GetWorkArea(xfc);
176 *workArea = xfc->workArea;
177 xfc->workArea = saved;
183static UINT xf_rail_send_workarea(xfContext* xfc)
187 if (!xfc->remote_app || !xfc->rail)
188 return CHANNEL_RC_OK;
190 xfWorkArea current = WINPR_C_ARRAY_INIT;
191 if (!xf_rail_get_workarea(xfc, ¤t))
192 return CHANNEL_RC_OK;
194 if ((current.x == xfc->railWorkArea.x) && (current.y == xfc->railWorkArea.y) &&
195 (current.width == xfc->railWorkArea.width) && (current.height == xfc->railWorkArea.height))
197 WLog_Print(xfc->log, WLOG_DEBUG,
198 "Suppressing work area %" PRId32
",%" PRId32
" %" PRIu32
"x%" PRIu32
200 current.x, current.y, current.width, current.height);
201 return CHANNEL_RC_OK;
204 const INT64 right = (INT64)current.x + current.width;
205 const INT64 bottom = (INT64)current.y + current.height;
208 WINPR_CXX_COMPAT_CAST(UINT16, current.x),
209 .workArea.top = WINPR_CXX_COMPAT_CAST(UINT16, current.y),
210 .workArea.right = WINPR_CXX_COMPAT_CAST(UINT16, right),
212 WINPR_CXX_COMPAT_CAST(UINT16, bottom) };
214 WLog_Print(xfc->log, WLOG_DEBUG,
215 "Sending work area %" PRId32
",%" PRId32
" %" PRIu32
"x%" PRIu32, current.x,
216 current.y, current.width, current.height);
217 const UINT rc = xfc->rail->ClientSystemParam(xfc->rail, &sysparam);
218 if (rc == CHANNEL_RC_OK)
219 xfc->railWorkArea = current;
224BOOL xf_rail_schedule_workarea(xfContext* xfc)
228 xfWorkArea current = WINPR_C_ARRAY_INIT;
229 if (!xf_rail_get_workarea(xfc, ¤t))
231 WLog_Print(xfc->log, WLOG_DEBUG,
"Suppressing work area update: current value unavailable");
235 return xf_rail_send_workarea(xfc) == CHANNEL_RC_OK;
238BOOL xf_rail_send_activate(xfContext* xfc, Window xwindow, BOOL enabled)
241 xfAppWindow* appWindow = xf_AppWindowFromX11Window(xfc, xwindow);
245 WLog_Print(xfc->log, WLOG_DEBUG,
"xf_rail_send_activate: ignoring unknown window 0x%08lx",
251 xf_SetWindowStyle(xfc, appWindow, appWindow->dwStyle, appWindow->dwExStyle);
253 WINPR_ASSERT(appWindow->windowId <= UINT32_MAX);
254 activate.windowId = (UINT32)appWindow->windowId;
255 xf_rail_return_window(appWindow, FALSE);
257 activate.enabled = enabled;
258 const UINT rc = xfc->rail->ClientActivate(xfc->rail, &activate);
259 return rc == CHANNEL_RC_OK;
262BOOL xf_rail_send_client_system_command(xfContext* xfc, UINT64 windowId, UINT16 command)
265 WINPR_ASSERT(xfc->rail);
266 WINPR_ASSERT(xfc->rail->ClientSystemCommand);
267 if (windowId > UINT32_MAX)
271 const UINT rc = xfc->rail->ClientSystemCommand(xfc->rail, &syscommand);
272 return rc == CHANNEL_RC_OK;
281BOOL xf_rail_adjust_position(xfContext* xfc, xfAppWindow* appWindow)
286 WINPR_ASSERT(appWindow);
288 if (!appWindow->is_mapped || appWindow->local_move.state != LMS_NOT_ACTIVE)
292 if (appWindow->override_redirect)
299 if (appWindow->x != appWindow->windowOffsetX || appWindow->y != appWindow->windowOffsetY ||
300 appWindow->width != (INT64)appWindow->windowWidth ||
301 appWindow->height != (INT64)appWindow->windowHeight)
303 WINPR_ASSERT(appWindow->windowId <= UINT32_MAX);
304 windowMove.windowId = (UINT32)appWindow->windowId;
309 const INT16 left = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginLeft);
310 const INT16 right = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginRight);
311 const INT16 top = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginTop);
312 const INT16 bottom = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginBottom);
313 windowMove.left = WINPR_ASSERTING_INT_CAST(INT16, appWindow->x - left);
314 windowMove.top = WINPR_ASSERTING_INT_CAST(INT16, appWindow->y - top);
315 windowMove.right = WINPR_ASSERTING_INT_CAST(INT16, appWindow->x + appWindow->width + right);
317 WINPR_ASSERTING_INT_CAST(INT16, appWindow->y + appWindow->height + bottom);
318 const UINT rc = xfc->rail->ClientWindowMove(xfc->rail, &windowMove);
319 return rc == CHANNEL_RC_OK;
324BOOL xf_rail_end_local_move(xfContext* xfc, xfAppWindow* appWindow)
330 unsigned int mask = 0;
331 Window root_window = 0;
332 Window child_window = 0;
335 WINPR_ASSERT(appWindow);
337 if ((appWindow->local_move.direction == NET_WM_MOVERESIZE_MOVE_KEYBOARD) ||
338 (appWindow->local_move.direction == NET_WM_MOVERESIZE_SIZE_KEYBOARD))
345 WINPR_ASSERT(appWindow->windowId <= UINT32_MAX);
346 windowMove.windowId = (UINT32)appWindow->windowId;
352 const INT16 left = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginLeft);
353 const INT16 right = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginRight);
354 const INT16 top = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginTop);
355 const INT16 bottom = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginBottom);
356 const INT16 w = WINPR_ASSERTING_INT_CAST(INT16, appWindow->width + right);
357 const INT16 h = WINPR_ASSERTING_INT_CAST(INT16, appWindow->height + bottom);
358 windowMove.left = WINPR_ASSERTING_INT_CAST(INT16, appWindow->x - left);
359 windowMove.top = WINPR_ASSERTING_INT_CAST(INT16, appWindow->y - top);
360 windowMove.right = WINPR_ASSERTING_INT_CAST(INT16, appWindow->x + w);
362 windowMove.bottom = WINPR_ASSERTING_INT_CAST(INT16, appWindow->y + h);
363 const UINT rc = xfc->rail->ClientWindowMove(xfc->rail, &windowMove);
364 if (rc != CHANNEL_RC_OK)
371 XQueryPointer(xfc->display, appWindow->handle, &root_window, &child_window, &x, &y, &child_x,
375 if ((appWindow->local_move.direction != NET_WM_MOVERESIZE_MOVE_KEYBOARD) &&
376 (appWindow->local_move.direction != NET_WM_MOVERESIZE_SIZE_KEYBOARD))
378 if (!freerdp_client_send_button_event(&xfc->common, FALSE, PTR_FLAGS_BUTTON1, x, y))
387 appWindow->windowOffsetX = appWindow->x;
388 appWindow->windowOffsetY = appWindow->y;
389 appWindow->windowWidth = WINPR_ASSERTING_INT_CAST(uint32_t, appWindow->width);
390 appWindow->windowHeight = WINPR_ASSERTING_INT_CAST(uint32_t, appWindow->height);
391 appWindow->local_move.state = LMS_TERMINATING;
395BOOL xf_rail_paint_surface(xfContext* xfc, UINT64 windowId,
const RECTANGLE_16* rect)
399 REGION16 windowInvalidRegion = WINPR_C_ARRAY_INIT;
400 xfAppWindow* appWindow = xf_rail_get_window(xfc, windowId, FALSE);
408 .left = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->x, 0)),
409 .top = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->y, 0)),
410 .right = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->x + appWindow->width, 0)),
411 .bottom = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->y + appWindow->height, 0))
414 region16_init(&windowInvalidRegion);
415 if (!region16_union_rect(&windowInvalidRegion, &windowInvalidRegion, &windowRect))
417 if (!region16_intersect_rect(&windowInvalidRegion, &windowInvalidRegion, rect))
420 if (!region16_is_empty(&windowInvalidRegion))
422 const RECTANGLE_16* extents = region16_extents(&windowInvalidRegion);
425 .left = WINPR_ASSERTING_INT_CAST(UINT16, extents->left - appWindow->x),
426 .top = WINPR_ASSERTING_INT_CAST(UINT16, extents->top - appWindow->y),
427 .right = WINPR_ASSERTING_INT_CAST(UINT16, extents->right - appWindow->x),
428 .bottom = WINPR_ASSERTING_INT_CAST(UINT16, extents->bottom - appWindow->y)
431 redraw = xf_UpdateWindowArea(xfc, appWindow, updateRect.left, updateRect.top,
432 updateRect.right - updateRect.left,
433 updateRect.bottom - updateRect.top);
438 const UINT32 surfaceId = appWindow->surfaceId;
439 region16_uninit(&windowInvalidRegion);
440 xf_rail_return_window(appWindow, FALSE);
442 xf_AppWindowRepaintFromSurface(xfc, windowId, surfaceId);
448static BOOL rail_paint_fn(
const void* pvkey, WINPR_ATTR_UNUSED
void* value,
void* pvarg)
450 rail_paint_fn_arg_t* arg = pvarg;
454 const UINT64 key = *(
const UINT64*)pvkey;
455 return xf_rail_paint_surface(arg->xfc, key, arg->rect);
458BOOL xf_rail_paint(xfContext* xfc,
const RECTANGLE_16* rect)
460 rail_paint_fn_arg_t arg = { .xfc = xfc, .rect = rect };
465 if (!xfc->railWindows)
468 return HashTable_Foreach(xfc->railWindows, rail_paint_fn, &arg);
471#define window_state_log_style(log, windowState) \
472 window_state_log_style_int((log), (windowState), __FILE__, __func__, __LINE__)
473static void window_state_log_style_int(wLog* log,
const WINDOW_STATE_ORDER* windowState,
474 const char* file,
const char* fkt,
size_t line)
476 const DWORD log_level = WLOG_DEBUG;
479 WINPR_ASSERT(windowState);
480 if (WLog_IsLevelActive(log, log_level))
482 char buffer1[128] = WINPR_C_ARRAY_INIT;
483 char buffer2[128] = WINPR_C_ARRAY_INIT;
485 window_styles_to_string(windowState->style, buffer1,
sizeof(buffer1));
486 window_styles_ex_to_string(windowState->extendedStyle, buffer2,
sizeof(buffer2));
487 WLog_PrintTextMessage(log, log_level, line, file, fkt,
"windowStyle={%s, %s}", buffer1,
494static BOOL xf_rail_window_common(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
499 UINT32 surfaceId = 0;
501 xfContext* xfc = (xfContext*)context;
504 WINPR_ASSERT(orderInfo);
505 WINPR_ASSERT(windowState);
507 UINT32 fieldFlags = orderInfo->fieldFlags;
508 BOOL position_or_size_updated = FALSE;
509 xfAppWindow* appWindow = xf_rail_get_window(xfc, orderInfo->windowId, FALSE);
511 if (fieldFlags & WINDOW_ORDER_STATE_NEW)
514 appWindow = xf_rail_add_window(xfc, orderInfo->windowId, windowState->windowOffsetX,
515 windowState->windowOffsetY, windowState->windowWidth,
516 windowState->windowHeight, 0xFFFFFFFF);
521 appWindow->dwStyle = windowState->style;
522 appWindow->dwExStyle = windowState->extendedStyle;
523 window_state_log_style(xfc->log, windowState);
526 if (fieldFlags & WINDOW_ORDER_FIELD_TITLE)
528 char* title = rail_string_to_utf8_string(&windowState->titleInfo);
531 WLog_Print(xfc->log, WLOG_ERROR,
"failed to duplicate window title string");
535 appWindow->title = title;
539 if (!(appWindow->title = _strdup(
"RdpRailWindow")))
540 WLog_Print(xfc->log, WLOG_ERROR,
"failed to duplicate default window title string");
543 if (!appWindow->title)
546 const BOOL hidden = ((fieldFlags & WINDOW_ORDER_FIELD_SHOW) != 0) &&
547 (windowState->showState == WINDOW_HIDE);
548 if (xf_AppWindowInit(xfc, appWindow, hidden))
555 surfaceId = appWindow->surfaceId;
556 windowId = appWindow->windowId;
559 if ((fieldFlags & WINDOW_ORDER_FIELD_WND_OFFSET) ||
560 (fieldFlags & WINDOW_ORDER_FIELD_WND_SIZE) ||
561 (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_OFFSET) ||
562 (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_SIZE) ||
563 (fieldFlags & WINDOW_ORDER_FIELD_WND_CLIENT_DELTA) ||
564 (fieldFlags & WINDOW_ORDER_FIELD_VIS_OFFSET) ||
565 (fieldFlags & WINDOW_ORDER_FIELD_VISIBILITY))
567 position_or_size_updated = TRUE;
572 if (fieldFlags & WINDOW_ORDER_FIELD_WND_OFFSET)
574 appWindow->windowOffsetX = windowState->windowOffsetX;
575 appWindow->windowOffsetY = windowState->windowOffsetY;
578 if (fieldFlags & WINDOW_ORDER_FIELD_WND_SIZE)
592 const UINT64 now = winpr_GetTickCount64NS() / 1000000ULL;
594 (appWindow->lastWndSizeUpdate != 0) && ((now - appWindow->lastWndSizeUpdate) < 1000);
595 const UINT32 newW = windowState->windowWidth;
596 const UINT32 newH = windowState->windowHeight;
597 const BOOL degenerate = (newW < 32) || (newH < 32);
598 const BOOL hadSane = (appWindow->windowWidth >= 32) && (appWindow->windowHeight >= 32);
600 if ((degenerate && hadSane) || burst)
602 WLog_Print(xfc->log, WLOG_DEBUG,
603 "coalescing RAIL window size %" PRIu32
"x%" PRIu32
604 " (burst=%d degenerate=%d)",
605 newW, newH, burst, degenerate);
609 appWindow->windowWidth = newW;
610 appWindow->windowHeight = newH;
611 appWindow->lastWndSizeUpdate = now;
615 if (fieldFlags & WINDOW_ORDER_FIELD_RESIZE_MARGIN_X)
617 appWindow->resizeMarginLeft = windowState->resizeMarginLeft;
618 appWindow->resizeMarginRight = windowState->resizeMarginRight;
621 if (fieldFlags & WINDOW_ORDER_FIELD_RESIZE_MARGIN_Y)
623 appWindow->resizeMarginTop = windowState->resizeMarginTop;
624 appWindow->resizeMarginBottom = windowState->resizeMarginBottom;
627 if (fieldFlags & WINDOW_ORDER_FIELD_OWNER)
629 appWindow->ownerWindowId = windowState->ownerWindowId;
632 if (fieldFlags & WINDOW_ORDER_FIELD_STYLE)
634 appWindow->dwStyle = windowState->style;
635 appWindow->dwExStyle = windowState->extendedStyle;
636 window_state_log_style(xfc->log, windowState);
639 if (fieldFlags & WINDOW_ORDER_FIELD_SHOW)
641 appWindow->showState = windowState->showState;
644 if (fieldFlags & WINDOW_ORDER_FIELD_TITLE)
646 char* title = rail_string_to_utf8_string(&windowState->titleInfo);
649 WLog_Print(xfc->log, WLOG_ERROR,
"failed to duplicate window title string");
653 free(appWindow->title);
654 appWindow->title = title;
657 if (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_OFFSET)
659 appWindow->clientOffsetX = windowState->clientOffsetX;
660 appWindow->clientOffsetY = windowState->clientOffsetY;
663 if (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_SIZE)
665 appWindow->clientAreaWidth = windowState->clientAreaWidth;
666 appWindow->clientAreaHeight = windowState->clientAreaHeight;
669 if (fieldFlags & WINDOW_ORDER_FIELD_WND_CLIENT_DELTA)
671 appWindow->windowClientDeltaX = windowState->windowClientDeltaX;
672 appWindow->windowClientDeltaY = windowState->windowClientDeltaY;
675 if (fieldFlags & WINDOW_ORDER_FIELD_WND_RECTS)
677 if (appWindow->windowRects)
679 free(appWindow->windowRects);
680 appWindow->windowRects =
nullptr;
683 appWindow->numWindowRects = windowState->numWindowRects;
685 if (appWindow->numWindowRects)
687 appWindow->windowRects =
690 if (!appWindow->windowRects)
693 CopyMemory(appWindow->windowRects, windowState->windowRects,
698 if (fieldFlags & WINDOW_ORDER_FIELD_VIS_OFFSET)
700 appWindow->visibleOffsetX = windowState->visibleOffsetX;
701 appWindow->visibleOffsetY = windowState->visibleOffsetY;
704 if (fieldFlags & WINDOW_ORDER_FIELD_VISIBILITY)
706 if (appWindow->visibilityRects)
708 free(appWindow->visibilityRects);
709 appWindow->visibilityRects =
nullptr;
712 appWindow->numVisibilityRects = windowState->numVisibilityRects;
714 if (appWindow->numVisibilityRects)
716 appWindow->visibilityRects =
719 if (!appWindow->visibilityRects)
722 CopyMemory(appWindow->visibilityRects, windowState->visibilityRects,
729 if (fieldFlags & WINDOW_ORDER_FIELD_STYLE)
733 if (fieldFlags & WINDOW_ORDER_FIELD_SHOW)
735 if (xf_ShowWindow(xfc, appWindow, WINPR_ASSERTING_INT_CAST(UINT8, appWindow->showState)))
739 if (fieldFlags & WINDOW_ORDER_FIELD_TITLE)
741 if (appWindow->title)
742 xf_SetWindowText(xfc, appWindow, appWindow->title);
745 if (position_or_size_updated)
747 const INT32 visibilityRectsOffsetX =
748 (appWindow->visibleOffsetX -
749 (appWindow->clientOffsetX - appWindow->windowClientDeltaX));
750 const INT32 visibilityRectsOffsetY =
751 (appWindow->visibleOffsetY -
752 (appWindow->clientOffsetY - appWindow->windowClientDeltaY));
759 if (appWindow->rail_state != WINDOW_SHOW_MINIMIZED)
761 const BOOL maximized = (appWindow->dwStyle & WS_MAXIMIZE) != 0;
763 if (maximized || (appWindow->x == (INT64)appWindow->windowOffsetX &&
764 appWindow->y == (INT64)appWindow->windowOffsetY &&
765 appWindow->width == (INT64)appWindow->windowWidth &&
766 appWindow->height == (INT64)appWindow->windowHeight))
768 if (xf_UpdateWindowArea(xfc, appWindow, 0, 0,
769 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowWidth),
770 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowHeight)))
775 if (xf_MoveWindow(xfc, appWindow, appWindow->windowOffsetX,
776 appWindow->windowOffsetY,
777 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowWidth),
778 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowHeight)))
784 xf_ClearWindowVisibilityRects(xfc, appWindow);
786 xf_SetWindowVisibilityRects(
787 xfc, appWindow, WINPR_ASSERTING_INT_CAST(uint32_t, visibilityRectsOffsetX),
788 WINPR_ASSERTING_INT_CAST(uint32_t, visibilityRectsOffsetY),
789 appWindow->visibilityRects,
790 WINPR_ASSERTING_INT_CAST(
int, appWindow->numVisibilityRects));
793 if (appWindow->rail_state == WINDOW_SHOW_MAXIMIZED)
795 xf_SendClientEvent(xfc, appWindow->handle, xfc->NET_WM_STATE, 4, NET_WM_STATE_ADD,
796 xfc->NET_WM_STATE_MAXIMIZED_VERT, xfc->NET_WM_STATE_MAXIMIZED_HORZ,
801 if (fieldFlags & (WINDOW_ORDER_STATE_NEW | WINDOW_ORDER_FIELD_STYLE))
802 xf_SetWindowStyle(xfc, appWindow, appWindow->dwStyle, appWindow->dwExStyle);
811 xf_rail_return_window(appWindow, FALSE);
813 xf_AppWindowRepaintFromSurface(xfc, windowId, surfaceId);
818static BOOL xf_rail_window_delete(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo)
820 xfContext* xfc = (xfContext*)context;
822 return xf_rail_del_window(xfc, orderInfo->windowId);
825static void RailIconCache_Free(xfRailIconCache* cache)
830 for (UINT32 i = 0; i < cache->numCaches * cache->numCacheEntries; i++)
832 xfRailIcon* cur = &cache->entries[i];
836 free(cache->scratch.data);
837 free(cache->entries);
841WINPR_ATTR_MALLOC(RailIconCache_Free, 1)
842static xfRailIconCache* RailIconCache_New(wLog* log, rdpSettings* settings)
844 xfRailIconCache* cache = calloc(1,
sizeof(xfRailIconCache));
850 cache->numCacheEntries =
852 cache->entries = calloc(1ull * cache->numCaches * cache->numCacheEntries,
sizeof(xfRailIcon));
856 WLog_Print(log, WLOG_ERROR,
857 "failed to allocate icon cache %" PRIu32
" x %" PRIu32
" entries",
858 cache->numCaches, cache->numCacheEntries);
867static xfRailIcon* RailIconCache_Lookup(xfRailIconCache* cache, UINT8 cacheId, UINT16 cacheEntry)
880 return &cache->scratch;
882 if (cacheId >= cache->numCaches)
885 if (cacheEntry >= cache->numCacheEntries)
888 return &cache->entries[cache->numCacheEntries * cacheId + cacheEntry];
902static BOOL convert_rail_icon(
const ICON_INFO* iconInfo, xfRailIcon* railIcon)
904 WINPR_ASSERT(iconInfo);
905 WINPR_ASSERT(railIcon);
907 BYTE* nextPixel =
nullptr;
908 long* pixels =
nullptr;
909 BYTE* argbPixels = calloc(1ull * iconInfo->width * iconInfo->height, 4);
914 if (!freerdp_image_copy_from_icon_data(
915 argbPixels, PIXEL_FORMAT_ARGB32, 0, 0, 0,
916 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->width),
917 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->height), iconInfo->bitsColor,
918 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->cbBitsColor), iconInfo->bitsMask,
919 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->cbBitsMask), iconInfo->colorTable,
920 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->cbColorTable), iconInfo->bpp))
924 const UINT32 nelements = 2 + iconInfo->width * iconInfo->height;
925 pixels = realloc(railIcon->data, nelements *
sizeof(
long));
930 railIcon->data = pixels;
932 railIcon->length = WINPR_ASSERTING_INT_CAST(
int, nelements);
933 pixels[0] = iconInfo->width;
934 pixels[1] = iconInfo->height;
935 nextPixel = argbPixels;
937 for (UINT32 i = 2; i < nelements; i++)
939 pixels[i] = FreeRDPReadColor(nextPixel, PIXEL_FORMAT_BGRA32);
951static void xf_rail_set_window_icon(xfContext* xfc, xfAppWindow* railWindow, xfRailIcon* icon,
956 LogDynAndXChangeProperty(xfc->log, xfc->display, railWindow->handle, xfc->NET_WM_ICON,
957 XA_CARDINAL, 32, replace ? PropModeReplace : PropModeAppend,
958 (unsigned char*)icon->data, icon->length);
959 LogDynAndXFlush(xfc->log, xfc->display);
963static BOOL xf_rail_window_icon(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
967 xfContext* xfc = (xfContext*)context;
968 BOOL replaceIcon = 0;
969 xfAppWindow* railWindow = xf_rail_get_window(xfc, orderInfo->windowId, FALSE);
974 WINPR_ASSERT(windowIcon);
975 WINPR_ASSERT(windowIcon->iconInfo);
976 xfRailIcon* icon = RailIconCache_Lookup(
977 xfc->railIconCache, WINPR_ASSERTING_INT_CAST(UINT8, windowIcon->iconInfo->cacheId),
978 WINPR_ASSERTING_INT_CAST(UINT16, windowIcon->iconInfo->cacheEntry));
982 WLog_Print(xfc->log, WLOG_WARN,
"failed to get icon from cache %02X:%04X",
983 windowIcon->iconInfo->cacheId, windowIcon->iconInfo->cacheEntry);
985 else if (!convert_rail_icon(windowIcon->iconInfo, icon))
987 WLog_Print(xfc->log, WLOG_WARN,
"failed to convert icon for window %08X",
988 orderInfo->windowId);
992 replaceIcon = !!(orderInfo->fieldFlags & WINDOW_ORDER_STATE_NEW);
993 xf_rail_set_window_icon(xfc, railWindow, icon, replaceIcon);
996 xf_rail_return_window(railWindow, FALSE);
1001static BOOL xf_rail_window_cached_icon(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
1005 xfContext* xfc = (xfContext*)context;
1006 WINPR_ASSERT(orderInfo);
1008 BOOL replaceIcon = 0;
1009 xfAppWindow* railWindow = xf_rail_get_window(xfc, orderInfo->windowId, FALSE);
1014 WINPR_ASSERT(windowCachedIcon);
1016 xfRailIcon* icon = RailIconCache_Lookup(
1017 xfc->railIconCache, WINPR_ASSERTING_INT_CAST(UINT8, windowCachedIcon->cachedIcon.cacheId),
1018 WINPR_ASSERTING_INT_CAST(UINT16, windowCachedIcon->cachedIcon.cacheEntry));
1022 WLog_Print(xfc->log, WLOG_WARN,
"failed to get icon from cache %02X:%04X",
1023 windowCachedIcon->cachedIcon.cacheId, windowCachedIcon->cachedIcon.cacheEntry);
1027 replaceIcon = !!(orderInfo->fieldFlags & WINDOW_ORDER_STATE_NEW);
1028 xf_rail_set_window_icon(xfc, railWindow, icon, replaceIcon);
1031 xf_rail_return_window(railWindow, FALSE);
1037xf_rail_notify_icon_common(WINPR_ATTR_UNUSED rdpContext* context,
1041 xfContext* xfc = (xfContext*)context;
1044 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1045 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_VERSION)
1049 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_TIP)
1053 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_INFO_TIP)
1057 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_STATE)
1061 if (orderInfo->fieldFlags & WINDOW_ORDER_ICON)
1065 if (orderInfo->fieldFlags & WINDOW_ORDER_CACHED_ICON)
1073static BOOL xf_rail_notify_icon_create(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
1076 return xf_rail_notify_icon_common(context, orderInfo, notifyIconState);
1080static BOOL xf_rail_notify_icon_update(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
1083 return xf_rail_notify_icon_common(context, orderInfo, notifyIconState);
1087static BOOL xf_rail_notify_icon_delete(WINPR_ATTR_UNUSED rdpContext* context,
1090 xfContext* xfc = (xfContext*)context;
1093 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1099xf_rail_monitored_desktop(WINPR_ATTR_UNUSED rdpContext* context,
1103 const UINT32 mask = WINDOW_ORDER_TYPE_DESKTOP | WINDOW_ORDER_FIELD_DESKTOP_HOOKED |
1104 WINDOW_ORDER_FIELD_DESKTOP_ARC_BEGAN |
1105 WINDOW_ORDER_FIELD_DESKTOP_ARC_COMPLETED |
1106 WINDOW_ORDER_FIELD_DESKTOP_ACTIVE_WND | WINDOW_ORDER_FIELD_DESKTOP_ZORDER;
1107 xfContext* xfc = (xfContext*)context;
1109 if (!context || !orderInfo || !monitoredDesktop)
1112 if ((orderInfo->fieldFlags & WINDOW_ORDER_TYPE_DESKTOP) == 0)
1114 WLog_Print(xfc->log, WLOG_WARN,
"WINDOW_ORDER_TYPE_DESKTOP flag missing!");
1118 if ((orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ARC_BEGAN) &&
1119 (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_HOOKED))
1122 WLog_Print(xfc->log, WLOG_WARN,
1123 "TODO: implement WINDOW_ORDER_FIELD_DESKTOP_ARC_BEGAN && "
1124 "WINDOW_ORDER_FIELD_DESKTOP_HOOKED");
1126 else if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_HOOKED)
1128 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_HOOKED");
1130 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ARC_COMPLETED)
1132 WLog_Print(xfc->log, WLOG_DEBUG,
1133 "WINDOW_ORDER_FIELD_DESKTOP_ARC_COMPLETED -> switch to RAILS mode");
1134 if (!xf_rail_enable_remoteapp_mode(xfc))
1137 if (!xf_rail_select_workarea_events(xfc))
1142 if ((app !=
nullptr) && (strnlen(app, 1) > 0))
1144 if (client_rail_server_start_cmd(xfc->rail) != CHANNEL_RC_OK)
1146 if (xf_rail_send_workarea(xfc) != CHANNEL_RC_OK)
1150 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ACTIVE_WND)
1152 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_ACTIVE_WND");
1154 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ZORDER)
1156 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_ZORDER");
1158 if (orderInfo->fieldFlags & ~mask)
1160 WLog_Print(xfc->log, WLOG_WARN,
"unknown flags 0x%08" PRIx32
"!", orderInfo->fieldFlags);
1166static BOOL xf_rail_non_monitored_desktop(rdpContext* context,
1169 xfContext* xfc = (xfContext*)context;
1170 const UINT32 mask = WINDOW_ORDER_TYPE_DESKTOP | WINDOW_ORDER_FIELD_DESKTOP_NONE;
1172 if (!context || !orderInfo)
1175 if ((orderInfo->fieldFlags & WINDOW_ORDER_TYPE_DESKTOP) == 0)
1177 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_TYPE_DESKTOP");
1180 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_NONE)
1182 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_NONE");
1184 if (orderInfo->fieldFlags & ~mask)
1186 WLog_Print(xfc->log, WLOG_WARN,
"unknown flags 0x%08" PRIx32
"!", orderInfo->fieldFlags);
1189 return xf_rail_disable_remoteapp_mode(xfc);
1192static void xf_rail_register_update_callbacks(rdpUpdate* update)
1194 WINPR_ASSERT(update);
1196 rdpWindowUpdate* window = update->window;
1197 WINPR_ASSERT(window);
1199 window->WindowCreate = xf_rail_window_common;
1200 window->WindowUpdate = xf_rail_window_common;
1201 window->WindowDelete = xf_rail_window_delete;
1202 window->WindowIcon = xf_rail_window_icon;
1203 window->WindowCachedIcon = xf_rail_window_cached_icon;
1204 window->NotifyIconCreate = xf_rail_notify_icon_create;
1205 window->NotifyIconUpdate = xf_rail_notify_icon_update;
1206 window->NotifyIconDelete = xf_rail_notify_icon_delete;
1207 window->MonitoredDesktop = xf_rail_monitored_desktop;
1208 window->NonMonitoredDesktop = xf_rail_non_monitored_desktop;
1219static UINT xf_rail_server_execute_result(RailClientContext* context,
1222 WINPR_ASSERT(context);
1223 WINPR_ASSERT(execResult);
1225 xfContext* xfc = (xfContext*)context->custom;
1228 if (execResult->execResult != RAIL_EXEC_S_OK)
1231 xfc->log, WLOG_ERROR,
"RAIL exec error: execResult=%s [0x%08" PRIx32
"] NtError=0x%X\n",
1232 error_code2str(execResult->execResult), execResult->execResult, execResult->rawResult);
1233 freerdp_abort_connect_context(&xfc->common.context);
1236 return CHANNEL_RC_OK;
1245static UINT xf_rail_server_system_param(WINPR_ATTR_UNUSED RailClientContext* context,
1248 WINPR_ASSERT(context);
1250 xfContext* xfc = (xfContext*)context->custom;
1254 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1255 return CHANNEL_RC_OK;
1264static UINT xf_rail_server_local_move_size(RailClientContext* context,
1270 Window child_window = 0;
1271 WINPR_ASSERT(context);
1272 WINPR_ASSERT(localMoveSize);
1274 xfContext* xfc = (xfContext*)context->custom;
1275 xfAppWindow* appWindow = xf_rail_get_window(xfc, localMoveSize->windowId, FALSE);
1278 return ERROR_INTERNAL_ERROR;
1280 WLog_Print(xfc->log, WLOG_TRACE,
"%s [0x%08" PRIx32
"]",
1281 movetype2str(localMoveSize->moveSizeType), localMoveSize->moveSizeType);
1282 switch (localMoveSize->moveSizeType)
1284 case RAIL_WMSZ_LEFT:
1285 direction = NET_WM_MOVERESIZE_SIZE_LEFT;
1286 x = localMoveSize->posX;
1287 y = localMoveSize->posY;
1290 case RAIL_WMSZ_RIGHT:
1291 direction = NET_WM_MOVERESIZE_SIZE_RIGHT;
1292 x = localMoveSize->posX;
1293 y = localMoveSize->posY;
1297 direction = NET_WM_MOVERESIZE_SIZE_TOP;
1298 x = localMoveSize->posX;
1299 y = localMoveSize->posY;
1302 case RAIL_WMSZ_TOPLEFT:
1303 direction = NET_WM_MOVERESIZE_SIZE_TOPLEFT;
1304 x = localMoveSize->posX;
1305 y = localMoveSize->posY;
1308 case RAIL_WMSZ_TOPRIGHT:
1309 direction = NET_WM_MOVERESIZE_SIZE_TOPRIGHT;
1310 x = localMoveSize->posX;
1311 y = localMoveSize->posY;
1314 case RAIL_WMSZ_BOTTOM:
1315 direction = NET_WM_MOVERESIZE_SIZE_BOTTOM;
1316 x = localMoveSize->posX;
1317 y = localMoveSize->posY;
1320 case RAIL_WMSZ_BOTTOMLEFT:
1321 direction = NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT;
1322 x = localMoveSize->posX;
1323 y = localMoveSize->posY;
1326 case RAIL_WMSZ_BOTTOMRIGHT:
1327 direction = NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT;
1328 x = localMoveSize->posX;
1329 y = localMoveSize->posY;
1332 case RAIL_WMSZ_MOVE:
1333 direction = NET_WM_MOVERESIZE_MOVE;
1334 XTranslateCoordinates(xfc->display, appWindow->handle, RootWindowOfScreen(xfc->screen),
1335 localMoveSize->posX, localMoveSize->posY, &x, &y, &child_window);
1338 case RAIL_WMSZ_KEYMOVE:
1339 direction = NET_WM_MOVERESIZE_MOVE_KEYBOARD;
1340 x = localMoveSize->posX;
1341 y = localMoveSize->posY;
1345 case RAIL_WMSZ_KEYSIZE:
1346 direction = NET_WM_MOVERESIZE_SIZE_KEYBOARD;
1347 x = localMoveSize->posX;
1348 y = localMoveSize->posY;
1355 if (localMoveSize->isMoveSizeStart)
1356 xf_StartLocalMoveSize(xfc, appWindow, direction, x, y);
1358 xf_EndLocalMoveSize(xfc, appWindow);
1360 xf_rail_return_window(appWindow, FALSE);
1361 return CHANNEL_RC_OK;
1370static UINT xf_rail_server_min_max_info(RailClientContext* context,
1373 WINPR_ASSERT(context);
1374 WINPR_ASSERT(minMaxInfo);
1376 xfContext* xfc = (xfContext*)context->custom;
1377 xfAppWindow* appWindow = xf_rail_get_window(xfc, minMaxInfo->windowId, FALSE);
1381 xf_SetWindowMinMaxInfo(xfc, appWindow, minMaxInfo->maxWidth, minMaxInfo->maxHeight,
1382 minMaxInfo->maxPosX, minMaxInfo->maxPosY, minMaxInfo->minTrackWidth,
1383 minMaxInfo->minTrackHeight, minMaxInfo->maxTrackWidth,
1384 minMaxInfo->maxTrackHeight);
1386 xf_rail_return_window(appWindow, FALSE);
1388 return CHANNEL_RC_OK;
1398xf_rail_server_language_bar_info(WINPR_ATTR_UNUSED RailClientContext* context,
1401 WINPR_ASSERT(context);
1403 xfContext* xfc = (xfContext*)context->custom;
1406 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1407 return CHANNEL_RC_OK;
1417xf_rail_server_get_appid_response(WINPR_ATTR_UNUSED RailClientContext* context,
1420 WINPR_ASSERT(context);
1422 xfContext* xfc = (xfContext*)context->custom;
1425 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1426 return CHANNEL_RC_OK;
1430static BOOL rail_window_key_equals(
const void* key1,
const void* key2)
1432 const UINT64* k1 = (
const UINT64*)key1;
1433 const UINT64* k2 = (
const UINT64*)key2;
1442static UINT32 rail_window_key_hash(
const void* key)
1444 const UINT64* k1 = (
const UINT64*)key;
1448static void rail_window_free(
void* value)
1450 xfAppWindow* appWindow = (xfAppWindow*)value;
1455 xf_DestroyWindow(appWindow->xfc, appWindow);
1458int xf_rail_init(xfContext* xfc, RailClientContext* rail)
1460 rdpContext* context = (rdpContext*)xfc;
1466 xf_rail_register_update_callbacks(context->update);
1467 rail->custom = (
void*)xfc;
1468 rail->ServerExecuteResult = xf_rail_server_execute_result;
1469 rail->ServerSystemParam = xf_rail_server_system_param;
1470 rail->ServerLocalMoveSize = xf_rail_server_local_move_size;
1471 rail->ServerMinMaxInfo = xf_rail_server_min_max_info;
1472 rail->ServerLanguageBarInfo = xf_rail_server_language_bar_info;
1473 rail->ServerGetAppIdResponse = xf_rail_server_get_appid_response;
1474 xfc->railWindows = HashTable_New(TRUE);
1476 if (!xfc->railWindows)
1479 if (!HashTable_SetHashFunction(xfc->railWindows, rail_window_key_hash))
1482 wObject* obj = HashTable_KeyObject(xfc->railWindows);
1486 wObject* obj = HashTable_ValueObject(xfc->railWindows);
1489 xfc->railIconCache = RailIconCache_New(xfc->log, xfc->common.context.settings);
1491 if (!xfc->railIconCache)
1497 HashTable_Free(xfc->railWindows);
1501int xf_rail_uninit(xfContext* xfc, RailClientContext* rail)
1507 xfc->rail->custom =
nullptr;
1508 xfc->rail =
nullptr;
1511 if (xfc->railWindows)
1513 HashTable_Free(xfc->railWindows);
1514 xfc->railWindows =
nullptr;
1517 if (xfc->railIconCache)
1519 RailIconCache_Free(xfc->railIconCache);
1520 xfc->railIconCache =
nullptr;
1526xfAppWindow* xf_rail_add_window(xfContext* xfc, UINT64
id, INT32 x, INT32 y, UINT32 width,
1527 UINT32 height, UINT32 surfaceId)
1532 xfAppWindow* appWindow = (xfAppWindow*)calloc(1,
sizeof(xfAppWindow));
1537 appWindow->xfc = xfc;
1538 appWindow->windowId = id;
1539 appWindow->surfaceId = surfaceId;
1542 appWindow->width = WINPR_ASSERTING_INT_CAST(
int, width);
1543 appWindow->height = WINPR_ASSERTING_INT_CAST(
int, height);
1545 xf_AppWindowsLock(xfc);
1546 if (!xf_AppWindowCreate(xfc, appWindow))
1549 if (!HashTable_Insert(xfc->railWindows, &appWindow->windowId, (
void*)appWindow))
1553 rail_window_free(appWindow);
1554 xf_AppWindowsUnlock(xfc);
1558BOOL xf_rail_del_window(xfContext* xfc, UINT64
id)
1563 if (!xfc->railWindows)
1567 const BOOL res = HashTable_Remove(xfc->railWindows, &
id);
1572void xf_rail_return_windowFrom(xfAppWindow* window, BOOL alreadyLocked,
const char* file,
1573 const char* fkt,
size_t line)
1581 xfAppWindowsUnlockFrom(window->xfc, file, fkt, line);
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
This struct contains function pointer to initialize/free objects.
OBJECT_FREE_FN fnObjectFree
WINPR_ATTR_NODISCARD OBJECT_EQUALS_FN fnObjectEquals