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)
295 if (appWindow->x != appWindow->windowOffsetX || appWindow->y != appWindow->windowOffsetY ||
296 appWindow->width != (INT64)appWindow->windowWidth ||
297 appWindow->height != (INT64)appWindow->windowHeight)
299 WINPR_ASSERT(appWindow->windowId <= UINT32_MAX);
300 windowMove.windowId = (UINT32)appWindow->windowId;
305 const INT16 left = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginLeft);
306 const INT16 right = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginRight);
307 const INT16 top = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginTop);
308 const INT16 bottom = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginBottom);
309 windowMove.left = WINPR_ASSERTING_INT_CAST(INT16, appWindow->x - left);
310 windowMove.top = WINPR_ASSERTING_INT_CAST(INT16, appWindow->y - top);
311 windowMove.right = WINPR_ASSERTING_INT_CAST(INT16, appWindow->x + appWindow->width + right);
313 WINPR_ASSERTING_INT_CAST(INT16, appWindow->y + appWindow->height + bottom);
314 const UINT rc = xfc->rail->ClientWindowMove(xfc->rail, &windowMove);
315 return rc == CHANNEL_RC_OK;
320BOOL xf_rail_end_local_move(xfContext* xfc, xfAppWindow* appWindow)
326 unsigned int mask = 0;
327 Window root_window = 0;
328 Window child_window = 0;
331 WINPR_ASSERT(appWindow);
333 if ((appWindow->local_move.direction == NET_WM_MOVERESIZE_MOVE_KEYBOARD) ||
334 (appWindow->local_move.direction == NET_WM_MOVERESIZE_SIZE_KEYBOARD))
341 WINPR_ASSERT(appWindow->windowId <= UINT32_MAX);
342 windowMove.windowId = (UINT32)appWindow->windowId;
348 const INT16 left = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginLeft);
349 const INT16 right = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginRight);
350 const INT16 top = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginTop);
351 const INT16 bottom = WINPR_ASSERTING_INT_CAST(INT16, appWindow->resizeMarginBottom);
352 const INT16 w = WINPR_ASSERTING_INT_CAST(INT16, appWindow->width + right);
353 const INT16 h = WINPR_ASSERTING_INT_CAST(INT16, appWindow->height + bottom);
354 windowMove.left = WINPR_ASSERTING_INT_CAST(INT16, appWindow->x - left);
355 windowMove.top = WINPR_ASSERTING_INT_CAST(INT16, appWindow->y - top);
356 windowMove.right = WINPR_ASSERTING_INT_CAST(INT16, appWindow->x + w);
358 windowMove.bottom = WINPR_ASSERTING_INT_CAST(INT16, appWindow->y + h);
359 const UINT rc = xfc->rail->ClientWindowMove(xfc->rail, &windowMove);
360 if (rc != CHANNEL_RC_OK)
367 XQueryPointer(xfc->display, appWindow->handle, &root_window, &child_window, &x, &y, &child_x,
371 if ((appWindow->local_move.direction != NET_WM_MOVERESIZE_MOVE_KEYBOARD) &&
372 (appWindow->local_move.direction != NET_WM_MOVERESIZE_SIZE_KEYBOARD))
374 if (!freerdp_client_send_button_event(&xfc->common, FALSE, PTR_FLAGS_BUTTON1, x, y))
383 appWindow->windowOffsetX = appWindow->x;
384 appWindow->windowOffsetY = appWindow->y;
385 appWindow->windowWidth = WINPR_ASSERTING_INT_CAST(uint32_t, appWindow->width);
386 appWindow->windowHeight = WINPR_ASSERTING_INT_CAST(uint32_t, appWindow->height);
387 appWindow->local_move.state = LMS_TERMINATING;
391BOOL xf_rail_paint_surface(xfContext* xfc, UINT64 windowId,
const RECTANGLE_16* rect)
395 REGION16 windowInvalidRegion = WINPR_C_ARRAY_INIT;
396 xfAppWindow* appWindow = xf_rail_get_window(xfc, windowId, FALSE);
404 .left = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->x, 0)),
405 .top = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->y, 0)),
406 .right = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->x + appWindow->width, 0)),
407 .bottom = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->y + appWindow->height, 0))
410 region16_init(&windowInvalidRegion);
411 if (!region16_union_rect(&windowInvalidRegion, &windowInvalidRegion, &windowRect))
413 if (!region16_intersect_rect(&windowInvalidRegion, &windowInvalidRegion, rect))
416 if (!region16_is_empty(&windowInvalidRegion))
418 const RECTANGLE_16* extents = region16_extents(&windowInvalidRegion);
421 .left = WINPR_ASSERTING_INT_CAST(UINT16, extents->left - appWindow->x),
422 .top = WINPR_ASSERTING_INT_CAST(UINT16, extents->top - appWindow->y),
423 .right = WINPR_ASSERTING_INT_CAST(UINT16, extents->right - appWindow->x),
424 .bottom = WINPR_ASSERTING_INT_CAST(UINT16, extents->bottom - appWindow->y)
427 redraw = xf_UpdateWindowArea(xfc, appWindow, updateRect.left, updateRect.top,
428 updateRect.right - updateRect.left,
429 updateRect.bottom - updateRect.top);
434 const UINT32 surfaceId = appWindow->surfaceId;
435 region16_uninit(&windowInvalidRegion);
436 xf_rail_return_window(appWindow, FALSE);
438 xf_AppWindowRepaintFromSurface(xfc, windowId, surfaceId);
444static BOOL rail_paint_fn(
const void* pvkey, WINPR_ATTR_UNUSED
void* value,
void* pvarg)
446 rail_paint_fn_arg_t* arg = pvarg;
450 const UINT64 key = *(
const UINT64*)pvkey;
451 return xf_rail_paint_surface(arg->xfc, key, arg->rect);
454BOOL xf_rail_paint(xfContext* xfc,
const RECTANGLE_16* rect)
456 rail_paint_fn_arg_t arg = { .xfc = xfc, .rect = rect };
461 if (!xfc->railWindows)
464 return HashTable_Foreach(xfc->railWindows, rail_paint_fn, &arg);
467#define window_state_log_style(log, windowState) \
468 window_state_log_style_int((log), (windowState), __FILE__, __func__, __LINE__)
469static void window_state_log_style_int(wLog* log,
const WINDOW_STATE_ORDER* windowState,
470 const char* file,
const char* fkt,
size_t line)
472 const DWORD log_level = WLOG_DEBUG;
475 WINPR_ASSERT(windowState);
476 if (WLog_IsLevelActive(log, log_level))
478 char buffer1[128] = WINPR_C_ARRAY_INIT;
479 char buffer2[128] = WINPR_C_ARRAY_INIT;
481 window_styles_to_string(windowState->style, buffer1,
sizeof(buffer1));
482 window_styles_ex_to_string(windowState->extendedStyle, buffer2,
sizeof(buffer2));
483 WLog_PrintTextMessage(log, log_level, line, file, fkt,
"windowStyle={%s, %s}", buffer1,
490static BOOL xf_rail_window_common(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
495 UINT32 surfaceId = 0;
497 xfContext* xfc = (xfContext*)context;
500 WINPR_ASSERT(orderInfo);
501 WINPR_ASSERT(windowState);
503 UINT32 fieldFlags = orderInfo->fieldFlags;
504 BOOL position_or_size_updated = FALSE;
505 xfAppWindow* appWindow = xf_rail_get_window(xfc, orderInfo->windowId, FALSE);
507 if (fieldFlags & WINDOW_ORDER_STATE_NEW)
510 appWindow = xf_rail_add_window(xfc, orderInfo->windowId, windowState->windowOffsetX,
511 windowState->windowOffsetY, windowState->windowWidth,
512 windowState->windowHeight, 0xFFFFFFFF);
517 appWindow->dwStyle = windowState->style;
518 appWindow->dwExStyle = windowState->extendedStyle;
519 window_state_log_style(xfc->log, windowState);
522 if (fieldFlags & WINDOW_ORDER_FIELD_TITLE)
524 char* title = rail_string_to_utf8_string(&windowState->titleInfo);
527 WLog_Print(xfc->log, WLOG_ERROR,
"failed to duplicate window title string");
531 appWindow->title = title;
535 if (!(appWindow->title = _strdup(
"RdpRailWindow")))
536 WLog_Print(xfc->log, WLOG_ERROR,
"failed to duplicate default window title string");
539 if (!appWindow->title)
542 const BOOL hidden = ((fieldFlags & WINDOW_ORDER_FIELD_SHOW) != 0) &&
543 (windowState->showState == WINDOW_HIDE);
544 if (xf_AppWindowInit(xfc, appWindow, hidden))
551 surfaceId = appWindow->surfaceId;
552 windowId = appWindow->windowId;
555 if ((fieldFlags & WINDOW_ORDER_FIELD_WND_OFFSET) ||
556 (fieldFlags & WINDOW_ORDER_FIELD_WND_SIZE) ||
557 (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_OFFSET) ||
558 (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_SIZE) ||
559 (fieldFlags & WINDOW_ORDER_FIELD_WND_CLIENT_DELTA) ||
560 (fieldFlags & WINDOW_ORDER_FIELD_VIS_OFFSET) ||
561 (fieldFlags & WINDOW_ORDER_FIELD_VISIBILITY))
563 position_or_size_updated = TRUE;
568 if (fieldFlags & WINDOW_ORDER_FIELD_WND_OFFSET)
570 appWindow->windowOffsetX = windowState->windowOffsetX;
571 appWindow->windowOffsetY = windowState->windowOffsetY;
574 if (fieldFlags & WINDOW_ORDER_FIELD_WND_SIZE)
588 const UINT64 now = winpr_GetTickCount64NS() / 1000000ULL;
590 (appWindow->lastWndSizeUpdate != 0) && ((now - appWindow->lastWndSizeUpdate) < 1000);
591 const UINT32 newW = windowState->windowWidth;
592 const UINT32 newH = windowState->windowHeight;
593 const BOOL degenerate = (newW < 32) || (newH < 32);
594 const BOOL hadSane = (appWindow->windowWidth >= 32) && (appWindow->windowHeight >= 32);
596 if ((degenerate && hadSane) || burst)
598 WLog_Print(xfc->log, WLOG_DEBUG,
599 "coalescing RAIL window size %" PRIu32
"x%" PRIu32
600 " (burst=%d degenerate=%d)",
601 newW, newH, burst, degenerate);
605 appWindow->windowWidth = newW;
606 appWindow->windowHeight = newH;
607 appWindow->lastWndSizeUpdate = now;
611 if (fieldFlags & WINDOW_ORDER_FIELD_RESIZE_MARGIN_X)
613 appWindow->resizeMarginLeft = windowState->resizeMarginLeft;
614 appWindow->resizeMarginRight = windowState->resizeMarginRight;
617 if (fieldFlags & WINDOW_ORDER_FIELD_RESIZE_MARGIN_Y)
619 appWindow->resizeMarginTop = windowState->resizeMarginTop;
620 appWindow->resizeMarginBottom = windowState->resizeMarginBottom;
623 if (fieldFlags & WINDOW_ORDER_FIELD_OWNER)
625 appWindow->ownerWindowId = windowState->ownerWindowId;
628 if (fieldFlags & WINDOW_ORDER_FIELD_STYLE)
630 appWindow->dwStyle = windowState->style;
631 appWindow->dwExStyle = windowState->extendedStyle;
632 window_state_log_style(xfc->log, windowState);
635 if (fieldFlags & WINDOW_ORDER_FIELD_SHOW)
637 appWindow->showState = windowState->showState;
640 if (fieldFlags & WINDOW_ORDER_FIELD_TITLE)
642 char* title = rail_string_to_utf8_string(&windowState->titleInfo);
645 WLog_Print(xfc->log, WLOG_ERROR,
"failed to duplicate window title string");
649 free(appWindow->title);
650 appWindow->title = title;
653 if (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_OFFSET)
655 appWindow->clientOffsetX = windowState->clientOffsetX;
656 appWindow->clientOffsetY = windowState->clientOffsetY;
659 if (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_SIZE)
661 appWindow->clientAreaWidth = windowState->clientAreaWidth;
662 appWindow->clientAreaHeight = windowState->clientAreaHeight;
665 if (fieldFlags & WINDOW_ORDER_FIELD_WND_CLIENT_DELTA)
667 appWindow->windowClientDeltaX = windowState->windowClientDeltaX;
668 appWindow->windowClientDeltaY = windowState->windowClientDeltaY;
671 if (fieldFlags & WINDOW_ORDER_FIELD_WND_RECTS)
673 if (appWindow->windowRects)
675 free(appWindow->windowRects);
676 appWindow->windowRects =
nullptr;
679 appWindow->numWindowRects = windowState->numWindowRects;
681 if (appWindow->numWindowRects)
683 appWindow->windowRects =
686 if (!appWindow->windowRects)
689 CopyMemory(appWindow->windowRects, windowState->windowRects,
694 if (fieldFlags & WINDOW_ORDER_FIELD_VIS_OFFSET)
696 appWindow->visibleOffsetX = windowState->visibleOffsetX;
697 appWindow->visibleOffsetY = windowState->visibleOffsetY;
700 if (fieldFlags & WINDOW_ORDER_FIELD_VISIBILITY)
702 if (appWindow->visibilityRects)
704 free(appWindow->visibilityRects);
705 appWindow->visibilityRects =
nullptr;
708 appWindow->numVisibilityRects = windowState->numVisibilityRects;
710 if (appWindow->numVisibilityRects)
712 appWindow->visibilityRects =
715 if (!appWindow->visibilityRects)
718 CopyMemory(appWindow->visibilityRects, windowState->visibilityRects,
725 if (fieldFlags & WINDOW_ORDER_FIELD_STYLE)
729 if (fieldFlags & WINDOW_ORDER_FIELD_SHOW)
731 if (xf_ShowWindow(xfc, appWindow, WINPR_ASSERTING_INT_CAST(UINT8, appWindow->showState)))
735 if (fieldFlags & WINDOW_ORDER_FIELD_TITLE)
737 if (appWindow->title)
738 xf_SetWindowText(xfc, appWindow, appWindow->title);
741 if (position_or_size_updated)
743 const INT32 visibilityRectsOffsetX =
744 (appWindow->visibleOffsetX -
745 (appWindow->clientOffsetX - appWindow->windowClientDeltaX));
746 const INT32 visibilityRectsOffsetY =
747 (appWindow->visibleOffsetY -
748 (appWindow->clientOffsetY - appWindow->windowClientDeltaY));
755 if (appWindow->rail_state != WINDOW_SHOW_MINIMIZED)
757 const BOOL maximized = (appWindow->dwStyle & WS_MAXIMIZE) != 0;
759 if (maximized || (appWindow->x == (INT64)appWindow->windowOffsetX &&
760 appWindow->y == (INT64)appWindow->windowOffsetY &&
761 appWindow->width == (INT64)appWindow->windowWidth &&
762 appWindow->height == (INT64)appWindow->windowHeight))
764 if (xf_UpdateWindowArea(xfc, appWindow, 0, 0,
765 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowWidth),
766 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowHeight)))
771 if (xf_MoveWindow(xfc, appWindow, appWindow->windowOffsetX,
772 appWindow->windowOffsetY,
773 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowWidth),
774 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowHeight)))
780 xf_ClearWindowVisibilityRects(xfc, appWindow);
782 xf_SetWindowVisibilityRects(
783 xfc, appWindow, WINPR_ASSERTING_INT_CAST(uint32_t, visibilityRectsOffsetX),
784 WINPR_ASSERTING_INT_CAST(uint32_t, visibilityRectsOffsetY),
785 appWindow->visibilityRects,
786 WINPR_ASSERTING_INT_CAST(
int, appWindow->numVisibilityRects));
789 if (appWindow->rail_state == WINDOW_SHOW_MAXIMIZED)
791 xf_SendClientEvent(xfc, appWindow->handle, xfc->NET_WM_STATE, 4, NET_WM_STATE_ADD,
792 xfc->NET_WM_STATE_MAXIMIZED_VERT, xfc->NET_WM_STATE_MAXIMIZED_HORZ,
797 if (fieldFlags & (WINDOW_ORDER_STATE_NEW | WINDOW_ORDER_FIELD_STYLE))
798 xf_SetWindowStyle(xfc, appWindow, appWindow->dwStyle, appWindow->dwExStyle);
807 xf_rail_return_window(appWindow, FALSE);
809 xf_AppWindowRepaintFromSurface(xfc, windowId, surfaceId);
814static BOOL xf_rail_window_delete(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo)
816 xfContext* xfc = (xfContext*)context;
818 return xf_rail_del_window(xfc, orderInfo->windowId);
821static void RailIconCache_Free(xfRailIconCache* cache)
826 for (UINT32 i = 0; i < cache->numCaches * cache->numCacheEntries; i++)
828 xfRailIcon* cur = &cache->entries[i];
832 free(cache->scratch.data);
833 free(cache->entries);
837WINPR_ATTR_MALLOC(RailIconCache_Free, 1)
838static xfRailIconCache* RailIconCache_New(wLog* log, rdpSettings* settings)
840 xfRailIconCache* cache = calloc(1,
sizeof(xfRailIconCache));
846 cache->numCacheEntries =
848 cache->entries = calloc(1ull * cache->numCaches * cache->numCacheEntries,
sizeof(xfRailIcon));
852 WLog_Print(log, WLOG_ERROR,
853 "failed to allocate icon cache %" PRIu32
" x %" PRIu32
" entries",
854 cache->numCaches, cache->numCacheEntries);
863static xfRailIcon* RailIconCache_Lookup(xfRailIconCache* cache, UINT8 cacheId, UINT16 cacheEntry)
876 return &cache->scratch;
878 if (cacheId >= cache->numCaches)
881 if (cacheEntry >= cache->numCacheEntries)
884 return &cache->entries[cache->numCacheEntries * cacheId + cacheEntry];
898static BOOL convert_rail_icon(
const ICON_INFO* iconInfo, xfRailIcon* railIcon)
900 WINPR_ASSERT(iconInfo);
901 WINPR_ASSERT(railIcon);
903 BYTE* nextPixel =
nullptr;
904 long* pixels =
nullptr;
905 BYTE* argbPixels = calloc(1ull * iconInfo->width * iconInfo->height, 4);
910 if (!freerdp_image_copy_from_icon_data(
911 argbPixels, PIXEL_FORMAT_ARGB32, 0, 0, 0,
912 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->width),
913 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->height), iconInfo->bitsColor,
914 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->cbBitsColor), iconInfo->bitsMask,
915 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->cbBitsMask), iconInfo->colorTable,
916 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->cbColorTable), iconInfo->bpp))
920 const UINT32 nelements = 2 + iconInfo->width * iconInfo->height;
921 pixels = realloc(railIcon->data, nelements *
sizeof(
long));
926 railIcon->data = pixels;
928 railIcon->length = WINPR_ASSERTING_INT_CAST(
int, nelements);
929 pixels[0] = iconInfo->width;
930 pixels[1] = iconInfo->height;
931 nextPixel = argbPixels;
933 for (UINT32 i = 2; i < nelements; i++)
935 pixels[i] = FreeRDPReadColor(nextPixel, PIXEL_FORMAT_BGRA32);
947static void xf_rail_set_window_icon(xfContext* xfc, xfAppWindow* railWindow, xfRailIcon* icon,
952 LogDynAndXChangeProperty(xfc->log, xfc->display, railWindow->handle, xfc->NET_WM_ICON,
953 XA_CARDINAL, 32, replace ? PropModeReplace : PropModeAppend,
954 (unsigned char*)icon->data, icon->length);
955 LogDynAndXFlush(xfc->log, xfc->display);
959static BOOL xf_rail_window_icon(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
963 xfContext* xfc = (xfContext*)context;
964 BOOL replaceIcon = 0;
965 xfAppWindow* railWindow = xf_rail_get_window(xfc, orderInfo->windowId, FALSE);
970 WINPR_ASSERT(windowIcon);
971 WINPR_ASSERT(windowIcon->iconInfo);
972 xfRailIcon* icon = RailIconCache_Lookup(
973 xfc->railIconCache, WINPR_ASSERTING_INT_CAST(UINT8, windowIcon->iconInfo->cacheId),
974 WINPR_ASSERTING_INT_CAST(UINT16, windowIcon->iconInfo->cacheEntry));
978 WLog_Print(xfc->log, WLOG_WARN,
"failed to get icon from cache %02X:%04X",
979 windowIcon->iconInfo->cacheId, windowIcon->iconInfo->cacheEntry);
981 else if (!convert_rail_icon(windowIcon->iconInfo, icon))
983 WLog_Print(xfc->log, WLOG_WARN,
"failed to convert icon for window %08X",
984 orderInfo->windowId);
988 replaceIcon = !!(orderInfo->fieldFlags & WINDOW_ORDER_STATE_NEW);
989 xf_rail_set_window_icon(xfc, railWindow, icon, replaceIcon);
992 xf_rail_return_window(railWindow, FALSE);
997static BOOL xf_rail_window_cached_icon(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
1001 xfContext* xfc = (xfContext*)context;
1002 WINPR_ASSERT(orderInfo);
1004 BOOL replaceIcon = 0;
1005 xfAppWindow* railWindow = xf_rail_get_window(xfc, orderInfo->windowId, FALSE);
1010 WINPR_ASSERT(windowCachedIcon);
1012 xfRailIcon* icon = RailIconCache_Lookup(
1013 xfc->railIconCache, WINPR_ASSERTING_INT_CAST(UINT8, windowCachedIcon->cachedIcon.cacheId),
1014 WINPR_ASSERTING_INT_CAST(UINT16, windowCachedIcon->cachedIcon.cacheEntry));
1018 WLog_Print(xfc->log, WLOG_WARN,
"failed to get icon from cache %02X:%04X",
1019 windowCachedIcon->cachedIcon.cacheId, windowCachedIcon->cachedIcon.cacheEntry);
1023 replaceIcon = !!(orderInfo->fieldFlags & WINDOW_ORDER_STATE_NEW);
1024 xf_rail_set_window_icon(xfc, railWindow, icon, replaceIcon);
1027 xf_rail_return_window(railWindow, FALSE);
1033xf_rail_notify_icon_common(WINPR_ATTR_UNUSED rdpContext* context,
1037 xfContext* xfc = (xfContext*)context;
1040 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1041 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_VERSION)
1045 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_TIP)
1049 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_INFO_TIP)
1053 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_STATE)
1057 if (orderInfo->fieldFlags & WINDOW_ORDER_ICON)
1061 if (orderInfo->fieldFlags & WINDOW_ORDER_CACHED_ICON)
1069static BOOL xf_rail_notify_icon_create(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
1072 return xf_rail_notify_icon_common(context, orderInfo, notifyIconState);
1076static BOOL xf_rail_notify_icon_update(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
1079 return xf_rail_notify_icon_common(context, orderInfo, notifyIconState);
1083static BOOL xf_rail_notify_icon_delete(WINPR_ATTR_UNUSED rdpContext* context,
1086 xfContext* xfc = (xfContext*)context;
1089 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1095xf_rail_monitored_desktop(WINPR_ATTR_UNUSED rdpContext* context,
1099 const UINT32 mask = WINDOW_ORDER_TYPE_DESKTOP | WINDOW_ORDER_FIELD_DESKTOP_HOOKED |
1100 WINDOW_ORDER_FIELD_DESKTOP_ARC_BEGAN |
1101 WINDOW_ORDER_FIELD_DESKTOP_ARC_COMPLETED |
1102 WINDOW_ORDER_FIELD_DESKTOP_ACTIVE_WND | WINDOW_ORDER_FIELD_DESKTOP_ZORDER;
1103 xfContext* xfc = (xfContext*)context;
1105 if (!context || !orderInfo || !monitoredDesktop)
1108 if ((orderInfo->fieldFlags & WINDOW_ORDER_TYPE_DESKTOP) == 0)
1110 WLog_Print(xfc->log, WLOG_WARN,
"WINDOW_ORDER_TYPE_DESKTOP flag missing!");
1114 if ((orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ARC_BEGAN) &&
1115 (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_HOOKED))
1118 WLog_Print(xfc->log, WLOG_WARN,
1119 "TODO: implement WINDOW_ORDER_FIELD_DESKTOP_ARC_BEGAN && "
1120 "WINDOW_ORDER_FIELD_DESKTOP_HOOKED");
1122 else if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_HOOKED)
1124 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_HOOKED");
1126 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ARC_COMPLETED)
1128 WLog_Print(xfc->log, WLOG_DEBUG,
1129 "WINDOW_ORDER_FIELD_DESKTOP_ARC_COMPLETED -> switch to RAILS mode");
1130 if (!xf_rail_enable_remoteapp_mode(xfc))
1133 if (!xf_rail_select_workarea_events(xfc))
1138 if ((app !=
nullptr) && (strnlen(app, 1) > 0))
1140 if (client_rail_server_start_cmd(xfc->rail) != CHANNEL_RC_OK)
1142 if (xf_rail_send_workarea(xfc) != CHANNEL_RC_OK)
1146 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ACTIVE_WND)
1148 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_ACTIVE_WND");
1150 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ZORDER)
1152 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_ZORDER");
1154 if (orderInfo->fieldFlags & ~mask)
1156 WLog_Print(xfc->log, WLOG_WARN,
"unknown flags 0x%08" PRIx32
"!", orderInfo->fieldFlags);
1162static BOOL xf_rail_non_monitored_desktop(rdpContext* context,
1165 xfContext* xfc = (xfContext*)context;
1166 const UINT32 mask = WINDOW_ORDER_TYPE_DESKTOP | WINDOW_ORDER_FIELD_DESKTOP_NONE;
1168 if (!context || !orderInfo)
1171 if ((orderInfo->fieldFlags & WINDOW_ORDER_TYPE_DESKTOP) == 0)
1173 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_TYPE_DESKTOP");
1176 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_NONE)
1178 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_NONE");
1180 if (orderInfo->fieldFlags & ~mask)
1182 WLog_Print(xfc->log, WLOG_WARN,
"unknown flags 0x%08" PRIx32
"!", orderInfo->fieldFlags);
1185 return xf_rail_disable_remoteapp_mode(xfc);
1188static void xf_rail_register_update_callbacks(rdpUpdate* update)
1190 WINPR_ASSERT(update);
1192 rdpWindowUpdate* window = update->window;
1193 WINPR_ASSERT(window);
1195 window->WindowCreate = xf_rail_window_common;
1196 window->WindowUpdate = xf_rail_window_common;
1197 window->WindowDelete = xf_rail_window_delete;
1198 window->WindowIcon = xf_rail_window_icon;
1199 window->WindowCachedIcon = xf_rail_window_cached_icon;
1200 window->NotifyIconCreate = xf_rail_notify_icon_create;
1201 window->NotifyIconUpdate = xf_rail_notify_icon_update;
1202 window->NotifyIconDelete = xf_rail_notify_icon_delete;
1203 window->MonitoredDesktop = xf_rail_monitored_desktop;
1204 window->NonMonitoredDesktop = xf_rail_non_monitored_desktop;
1215static UINT xf_rail_server_execute_result(RailClientContext* context,
1218 WINPR_ASSERT(context);
1219 WINPR_ASSERT(execResult);
1221 xfContext* xfc = (xfContext*)context->custom;
1224 if (execResult->execResult != RAIL_EXEC_S_OK)
1227 xfc->log, WLOG_ERROR,
"RAIL exec error: execResult=%s [0x%08" PRIx32
"] NtError=0x%X\n",
1228 error_code2str(execResult->execResult), execResult->execResult, execResult->rawResult);
1229 freerdp_abort_connect_context(&xfc->common.context);
1232 return CHANNEL_RC_OK;
1241static UINT xf_rail_server_system_param(WINPR_ATTR_UNUSED RailClientContext* context,
1244 WINPR_ASSERT(context);
1246 xfContext* xfc = (xfContext*)context->custom;
1250 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1251 return CHANNEL_RC_OK;
1260static UINT xf_rail_server_local_move_size(RailClientContext* context,
1266 Window child_window = 0;
1267 WINPR_ASSERT(context);
1268 WINPR_ASSERT(localMoveSize);
1270 xfContext* xfc = (xfContext*)context->custom;
1271 xfAppWindow* appWindow = xf_rail_get_window(xfc, localMoveSize->windowId, FALSE);
1274 return ERROR_INTERNAL_ERROR;
1276 WLog_Print(xfc->log, WLOG_TRACE,
"%s [0x%08" PRIx32
"]",
1277 movetype2str(localMoveSize->moveSizeType), localMoveSize->moveSizeType);
1278 switch (localMoveSize->moveSizeType)
1280 case RAIL_WMSZ_LEFT:
1281 direction = NET_WM_MOVERESIZE_SIZE_LEFT;
1282 x = localMoveSize->posX;
1283 y = localMoveSize->posY;
1286 case RAIL_WMSZ_RIGHT:
1287 direction = NET_WM_MOVERESIZE_SIZE_RIGHT;
1288 x = localMoveSize->posX;
1289 y = localMoveSize->posY;
1293 direction = NET_WM_MOVERESIZE_SIZE_TOP;
1294 x = localMoveSize->posX;
1295 y = localMoveSize->posY;
1298 case RAIL_WMSZ_TOPLEFT:
1299 direction = NET_WM_MOVERESIZE_SIZE_TOPLEFT;
1300 x = localMoveSize->posX;
1301 y = localMoveSize->posY;
1304 case RAIL_WMSZ_TOPRIGHT:
1305 direction = NET_WM_MOVERESIZE_SIZE_TOPRIGHT;
1306 x = localMoveSize->posX;
1307 y = localMoveSize->posY;
1310 case RAIL_WMSZ_BOTTOM:
1311 direction = NET_WM_MOVERESIZE_SIZE_BOTTOM;
1312 x = localMoveSize->posX;
1313 y = localMoveSize->posY;
1316 case RAIL_WMSZ_BOTTOMLEFT:
1317 direction = NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT;
1318 x = localMoveSize->posX;
1319 y = localMoveSize->posY;
1322 case RAIL_WMSZ_BOTTOMRIGHT:
1323 direction = NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT;
1324 x = localMoveSize->posX;
1325 y = localMoveSize->posY;
1328 case RAIL_WMSZ_MOVE:
1329 direction = NET_WM_MOVERESIZE_MOVE;
1330 XTranslateCoordinates(xfc->display, appWindow->handle, RootWindowOfScreen(xfc->screen),
1331 localMoveSize->posX, localMoveSize->posY, &x, &y, &child_window);
1334 case RAIL_WMSZ_KEYMOVE:
1335 direction = NET_WM_MOVERESIZE_MOVE_KEYBOARD;
1336 x = localMoveSize->posX;
1337 y = localMoveSize->posY;
1341 case RAIL_WMSZ_KEYSIZE:
1342 direction = NET_WM_MOVERESIZE_SIZE_KEYBOARD;
1343 x = localMoveSize->posX;
1344 y = localMoveSize->posY;
1351 if (localMoveSize->isMoveSizeStart)
1352 xf_StartLocalMoveSize(xfc, appWindow, direction, x, y);
1354 xf_EndLocalMoveSize(xfc, appWindow);
1356 xf_rail_return_window(appWindow, FALSE);
1357 return CHANNEL_RC_OK;
1366static UINT xf_rail_server_min_max_info(RailClientContext* context,
1369 WINPR_ASSERT(context);
1370 WINPR_ASSERT(minMaxInfo);
1372 xfContext* xfc = (xfContext*)context->custom;
1373 xfAppWindow* appWindow = xf_rail_get_window(xfc, minMaxInfo->windowId, FALSE);
1377 xf_SetWindowMinMaxInfo(xfc, appWindow, minMaxInfo->maxWidth, minMaxInfo->maxHeight,
1378 minMaxInfo->maxPosX, minMaxInfo->maxPosY, minMaxInfo->minTrackWidth,
1379 minMaxInfo->minTrackHeight, minMaxInfo->maxTrackWidth,
1380 minMaxInfo->maxTrackHeight);
1382 xf_rail_return_window(appWindow, FALSE);
1384 return CHANNEL_RC_OK;
1394xf_rail_server_language_bar_info(WINPR_ATTR_UNUSED RailClientContext* context,
1397 WINPR_ASSERT(context);
1399 xfContext* xfc = (xfContext*)context->custom;
1402 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1403 return CHANNEL_RC_OK;
1413xf_rail_server_get_appid_response(WINPR_ATTR_UNUSED RailClientContext* context,
1416 WINPR_ASSERT(context);
1418 xfContext* xfc = (xfContext*)context->custom;
1421 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1422 return CHANNEL_RC_OK;
1426static BOOL rail_window_key_equals(
const void* key1,
const void* key2)
1428 const UINT64* k1 = (
const UINT64*)key1;
1429 const UINT64* k2 = (
const UINT64*)key2;
1438static UINT32 rail_window_key_hash(
const void* key)
1440 const UINT64* k1 = (
const UINT64*)key;
1444static void rail_window_free(
void* value)
1446 xfAppWindow* appWindow = (xfAppWindow*)value;
1451 xf_DestroyWindow(appWindow->xfc, appWindow);
1454int xf_rail_init(xfContext* xfc, RailClientContext* rail)
1456 rdpContext* context = (rdpContext*)xfc;
1462 xf_rail_register_update_callbacks(context->update);
1463 rail->custom = (
void*)xfc;
1464 rail->ServerExecuteResult = xf_rail_server_execute_result;
1465 rail->ServerSystemParam = xf_rail_server_system_param;
1466 rail->ServerLocalMoveSize = xf_rail_server_local_move_size;
1467 rail->ServerMinMaxInfo = xf_rail_server_min_max_info;
1468 rail->ServerLanguageBarInfo = xf_rail_server_language_bar_info;
1469 rail->ServerGetAppIdResponse = xf_rail_server_get_appid_response;
1470 xfc->railWindows = HashTable_New(TRUE);
1472 if (!xfc->railWindows)
1475 if (!HashTable_SetHashFunction(xfc->railWindows, rail_window_key_hash))
1478 wObject* obj = HashTable_KeyObject(xfc->railWindows);
1482 wObject* obj = HashTable_ValueObject(xfc->railWindows);
1485 xfc->railIconCache = RailIconCache_New(xfc->log, xfc->common.context.settings);
1487 if (!xfc->railIconCache)
1493 HashTable_Free(xfc->railWindows);
1497int xf_rail_uninit(xfContext* xfc, RailClientContext* rail)
1503 xfc->rail->custom =
nullptr;
1504 xfc->rail =
nullptr;
1507 if (xfc->railWindows)
1509 HashTable_Free(xfc->railWindows);
1510 xfc->railWindows =
nullptr;
1513 if (xfc->railIconCache)
1515 RailIconCache_Free(xfc->railIconCache);
1516 xfc->railIconCache =
nullptr;
1522xfAppWindow* xf_rail_add_window(xfContext* xfc, UINT64
id, INT32 x, INT32 y, UINT32 width,
1523 UINT32 height, UINT32 surfaceId)
1528 xfAppWindow* appWindow = (xfAppWindow*)calloc(1,
sizeof(xfAppWindow));
1533 appWindow->xfc = xfc;
1534 appWindow->windowId = id;
1535 appWindow->surfaceId = surfaceId;
1538 appWindow->width = WINPR_ASSERTING_INT_CAST(
int, width);
1539 appWindow->height = WINPR_ASSERTING_INT_CAST(
int, height);
1541 xf_AppWindowsLock(xfc);
1542 if (!xf_AppWindowCreate(xfc, appWindow))
1545 if (!HashTable_Insert(xfc->railWindows, &appWindow->windowId, (
void*)appWindow))
1549 rail_window_free(appWindow);
1550 xf_AppWindowsUnlock(xfc);
1554BOOL xf_rail_del_window(xfContext* xfc, UINT64
id)
1559 if (!xfc->railWindows)
1563 const BOOL res = HashTable_Remove(xfc->railWindows, &
id);
1568void xf_rail_return_windowFrom(xfAppWindow* window, BOOL alreadyLocked,
const char* file,
1569 const char* fkt,
size_t line)
1577 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