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)
393 xfAppWindow* appWindow = xf_rail_get_window(xfc, windowId, FALSE);
401 .left = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->x, 0)),
402 .top = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->y, 0)),
403 .right = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->x + appWindow->width, 0)),
404 .bottom = WINPR_ASSERTING_INT_CAST(UINT16, MAX(appWindow->y + appWindow->height, 0))
407 REGION16 windowInvalidRegion = WINPR_C_ARRAY_INIT;
408 region16_init(&windowInvalidRegion);
409 if (!region16_union_rect(&windowInvalidRegion, &windowInvalidRegion, &windowRect))
411 if (!region16_intersect_rect(&windowInvalidRegion, &windowInvalidRegion, rect))
414 if (!region16_is_empty(&windowInvalidRegion))
416 const RECTANGLE_16* extents = region16_extents(&windowInvalidRegion);
419 .left = WINPR_ASSERTING_INT_CAST(UINT16, extents->left - appWindow->x),
420 .top = WINPR_ASSERTING_INT_CAST(UINT16, extents->top - appWindow->y),
421 .right = WINPR_ASSERTING_INT_CAST(UINT16, extents->right - appWindow->x),
422 .bottom = WINPR_ASSERTING_INT_CAST(UINT16, extents->bottom - appWindow->y)
425 xf_UpdateWindowArea(xfc, appWindow, updateRect.left, updateRect.top,
426 updateRect.right - updateRect.left, updateRect.bottom - updateRect.top);
428 region16_uninit(&windowInvalidRegion);
429 xf_rail_return_window(appWindow, FALSE);
434static BOOL rail_paint_fn(
const void* pvkey, WINPR_ATTR_UNUSED
void* value,
void* pvarg)
436 rail_paint_fn_arg_t* arg = pvarg;
440 const UINT64 key = *(
const UINT64*)pvkey;
441 return xf_rail_paint_surface(arg->xfc, key, arg->rect);
444BOOL xf_rail_paint(xfContext* xfc,
const RECTANGLE_16* rect)
446 rail_paint_fn_arg_t arg = { .xfc = xfc, .rect = rect };
451 if (!xfc->railWindows)
454 return HashTable_Foreach(xfc->railWindows, rail_paint_fn, &arg);
457#define window_state_log_style(log, windowState) \
458 window_state_log_style_int((log), (windowState), __FILE__, __func__, __LINE__)
459static void window_state_log_style_int(wLog* log,
const WINDOW_STATE_ORDER* windowState,
460 const char* file,
const char* fkt,
size_t line)
462 const DWORD log_level = WLOG_DEBUG;
465 WINPR_ASSERT(windowState);
466 if (WLog_IsLevelActive(log, log_level))
468 char buffer1[128] = WINPR_C_ARRAY_INIT;
469 char buffer2[128] = WINPR_C_ARRAY_INIT;
471 window_styles_to_string(windowState->style, buffer1,
sizeof(buffer1));
472 window_styles_ex_to_string(windowState->extendedStyle, buffer2,
sizeof(buffer2));
473 WLog_PrintTextMessage(log, log_level, line, file, fkt,
"windowStyle={%s, %s}", buffer1,
480static BOOL xf_rail_window_common(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
484 xfContext* xfc = (xfContext*)context;
487 WINPR_ASSERT(orderInfo);
488 WINPR_ASSERT(windowState);
490 UINT32 fieldFlags = orderInfo->fieldFlags;
491 BOOL position_or_size_updated = FALSE;
492 xfAppWindow* appWindow = xf_rail_get_window(xfc, orderInfo->windowId, FALSE);
494 if (fieldFlags & WINDOW_ORDER_STATE_NEW)
497 appWindow = xf_rail_add_window(xfc, orderInfo->windowId, windowState->windowOffsetX,
498 windowState->windowOffsetY, windowState->windowWidth,
499 windowState->windowHeight, 0xFFFFFFFF);
504 appWindow->dwStyle = windowState->style;
505 appWindow->dwExStyle = windowState->extendedStyle;
506 window_state_log_style(xfc->log, windowState);
509 if (fieldFlags & WINDOW_ORDER_FIELD_TITLE)
511 char* title = rail_string_to_utf8_string(&windowState->titleInfo);
514 WLog_Print(xfc->log, WLOG_ERROR,
"failed to duplicate window title string");
518 appWindow->title = title;
522 if (!(appWindow->title = _strdup(
"RdpRailWindow")))
523 WLog_Print(xfc->log, WLOG_ERROR,
"failed to duplicate default window title string");
526 if (!appWindow->title)
529 xf_AppWindowInit(xfc, appWindow);
536 if ((fieldFlags & WINDOW_ORDER_FIELD_WND_OFFSET) ||
537 (fieldFlags & WINDOW_ORDER_FIELD_WND_SIZE) ||
538 (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_OFFSET) ||
539 (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_SIZE) ||
540 (fieldFlags & WINDOW_ORDER_FIELD_WND_CLIENT_DELTA) ||
541 (fieldFlags & WINDOW_ORDER_FIELD_VIS_OFFSET) ||
542 (fieldFlags & WINDOW_ORDER_FIELD_VISIBILITY))
544 position_or_size_updated = TRUE;
549 if (fieldFlags & WINDOW_ORDER_FIELD_WND_OFFSET)
551 appWindow->windowOffsetX = windowState->windowOffsetX;
552 appWindow->windowOffsetY = windowState->windowOffsetY;
555 if (fieldFlags & WINDOW_ORDER_FIELD_WND_SIZE)
569 const UINT64 now = winpr_GetTickCount64NS() / 1000000ULL;
571 (appWindow->lastWndSizeUpdate != 0) && ((now - appWindow->lastWndSizeUpdate) < 1000);
572 const UINT32 newW = windowState->windowWidth;
573 const UINT32 newH = windowState->windowHeight;
574 const BOOL degenerate = (newW < 32) || (newH < 32);
575 const BOOL hadSane = (appWindow->windowWidth >= 32) && (appWindow->windowHeight >= 32);
577 if ((degenerate && hadSane) || burst)
579 WLog_Print(xfc->log, WLOG_DEBUG,
580 "coalescing RAIL window size %" PRIu32
"x%" PRIu32
581 " (burst=%d degenerate=%d)",
582 newW, newH, burst, degenerate);
586 appWindow->windowWidth = newW;
587 appWindow->windowHeight = newH;
588 appWindow->lastWndSizeUpdate = now;
592 if (fieldFlags & WINDOW_ORDER_FIELD_RESIZE_MARGIN_X)
594 appWindow->resizeMarginLeft = windowState->resizeMarginLeft;
595 appWindow->resizeMarginRight = windowState->resizeMarginRight;
598 if (fieldFlags & WINDOW_ORDER_FIELD_RESIZE_MARGIN_Y)
600 appWindow->resizeMarginTop = windowState->resizeMarginTop;
601 appWindow->resizeMarginBottom = windowState->resizeMarginBottom;
604 if (fieldFlags & WINDOW_ORDER_FIELD_OWNER)
606 appWindow->ownerWindowId = windowState->ownerWindowId;
609 if (fieldFlags & WINDOW_ORDER_FIELD_STYLE)
611 appWindow->dwStyle = windowState->style;
612 appWindow->dwExStyle = windowState->extendedStyle;
613 window_state_log_style(xfc->log, windowState);
616 if (fieldFlags & WINDOW_ORDER_FIELD_SHOW)
618 appWindow->showState = windowState->showState;
621 if (fieldFlags & WINDOW_ORDER_FIELD_TITLE)
623 char* title = rail_string_to_utf8_string(&windowState->titleInfo);
626 WLog_Print(xfc->log, WLOG_ERROR,
"failed to duplicate window title string");
630 free(appWindow->title);
631 appWindow->title = title;
634 if (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_OFFSET)
636 appWindow->clientOffsetX = windowState->clientOffsetX;
637 appWindow->clientOffsetY = windowState->clientOffsetY;
640 if (fieldFlags & WINDOW_ORDER_FIELD_CLIENT_AREA_SIZE)
642 appWindow->clientAreaWidth = windowState->clientAreaWidth;
643 appWindow->clientAreaHeight = windowState->clientAreaHeight;
646 if (fieldFlags & WINDOW_ORDER_FIELD_WND_CLIENT_DELTA)
648 appWindow->windowClientDeltaX = windowState->windowClientDeltaX;
649 appWindow->windowClientDeltaY = windowState->windowClientDeltaY;
652 if (fieldFlags & WINDOW_ORDER_FIELD_WND_RECTS)
654 if (appWindow->windowRects)
656 free(appWindow->windowRects);
657 appWindow->windowRects =
nullptr;
660 appWindow->numWindowRects = windowState->numWindowRects;
662 if (appWindow->numWindowRects)
664 appWindow->windowRects =
667 if (!appWindow->windowRects)
670 CopyMemory(appWindow->windowRects, windowState->windowRects,
675 if (fieldFlags & WINDOW_ORDER_FIELD_VIS_OFFSET)
677 appWindow->visibleOffsetX = windowState->visibleOffsetX;
678 appWindow->visibleOffsetY = windowState->visibleOffsetY;
681 if (fieldFlags & WINDOW_ORDER_FIELD_VISIBILITY)
683 if (appWindow->visibilityRects)
685 free(appWindow->visibilityRects);
686 appWindow->visibilityRects =
nullptr;
689 appWindow->numVisibilityRects = windowState->numVisibilityRects;
691 if (appWindow->numVisibilityRects)
693 appWindow->visibilityRects =
696 if (!appWindow->visibilityRects)
699 CopyMemory(appWindow->visibilityRects, windowState->visibilityRects,
706 if (fieldFlags & WINDOW_ORDER_FIELD_STYLE)
710 if (fieldFlags & WINDOW_ORDER_FIELD_SHOW)
712 xf_ShowWindow(xfc, appWindow, WINPR_ASSERTING_INT_CAST(UINT8, appWindow->showState));
715 if (fieldFlags & WINDOW_ORDER_FIELD_TITLE)
717 if (appWindow->title)
718 xf_SetWindowText(xfc, appWindow, appWindow->title);
721 if (position_or_size_updated)
723 const INT32 visibilityRectsOffsetX =
724 (appWindow->visibleOffsetX -
725 (appWindow->clientOffsetX - appWindow->windowClientDeltaX));
726 const INT32 visibilityRectsOffsetY =
727 (appWindow->visibleOffsetY -
728 (appWindow->clientOffsetY - appWindow->windowClientDeltaY));
735 if (appWindow->rail_state != WINDOW_SHOW_MINIMIZED)
737 const BOOL maximized = (appWindow->dwStyle & WS_MAXIMIZE) != 0;
739 if (maximized || (appWindow->x == (INT64)appWindow->windowOffsetX &&
740 appWindow->y == (INT64)appWindow->windowOffsetY &&
741 appWindow->width == (INT64)appWindow->windowWidth &&
742 appWindow->height == (INT64)appWindow->windowHeight))
744 xf_UpdateWindowArea(xfc, appWindow, 0, 0,
745 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowWidth),
746 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowHeight));
750 xf_MoveWindow(xfc, appWindow, appWindow->windowOffsetX, appWindow->windowOffsetY,
751 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowWidth),
752 WINPR_ASSERTING_INT_CAST(
int, appWindow->windowHeight));
757 xf_ClearWindowVisibilityRects(xfc, appWindow);
759 xf_SetWindowVisibilityRects(
760 xfc, appWindow, WINPR_ASSERTING_INT_CAST(uint32_t, visibilityRectsOffsetX),
761 WINPR_ASSERTING_INT_CAST(uint32_t, visibilityRectsOffsetY),
762 appWindow->visibilityRects,
763 WINPR_ASSERTING_INT_CAST(
int, appWindow->numVisibilityRects));
766 if (appWindow->rail_state == WINDOW_SHOW_MAXIMIZED)
768 xf_SendClientEvent(xfc, appWindow->handle, xfc->NET_WM_STATE, 4, NET_WM_STATE_ADD,
769 xfc->NET_WM_STATE_MAXIMIZED_VERT, xfc->NET_WM_STATE_MAXIMIZED_HORZ,
774 if (fieldFlags & (WINDOW_ORDER_STATE_NEW | WINDOW_ORDER_FIELD_STYLE))
775 xf_SetWindowStyle(xfc, appWindow, appWindow->dwStyle, appWindow->dwExStyle);
784 xf_rail_return_window(appWindow, FALSE);
789static BOOL xf_rail_window_delete(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo)
791 xfContext* xfc = (xfContext*)context;
793 return xf_rail_del_window(xfc, orderInfo->windowId);
796static void RailIconCache_Free(xfRailIconCache* cache)
801 for (UINT32 i = 0; i < cache->numCaches * cache->numCacheEntries; i++)
803 xfRailIcon* cur = &cache->entries[i];
807 free(cache->scratch.data);
808 free(cache->entries);
812WINPR_ATTR_MALLOC(RailIconCache_Free, 1)
813static xfRailIconCache* RailIconCache_New(wLog* log, rdpSettings* settings)
815 xfRailIconCache* cache = calloc(1,
sizeof(xfRailIconCache));
821 cache->numCacheEntries =
823 cache->entries = calloc(1ull * cache->numCaches * cache->numCacheEntries,
sizeof(xfRailIcon));
827 WLog_Print(log, WLOG_ERROR,
828 "failed to allocate icon cache %" PRIu32
" x %" PRIu32
" entries",
829 cache->numCaches, cache->numCacheEntries);
838static xfRailIcon* RailIconCache_Lookup(xfRailIconCache* cache, UINT8 cacheId, UINT16 cacheEntry)
851 return &cache->scratch;
853 if (cacheId >= cache->numCaches)
856 if (cacheEntry >= cache->numCacheEntries)
859 return &cache->entries[cache->numCacheEntries * cacheId + cacheEntry];
873static BOOL convert_rail_icon(
const ICON_INFO* iconInfo, xfRailIcon* railIcon)
875 WINPR_ASSERT(iconInfo);
876 WINPR_ASSERT(railIcon);
878 BYTE* nextPixel =
nullptr;
879 long* pixels =
nullptr;
880 BYTE* argbPixels = calloc(1ull * iconInfo->width * iconInfo->height, 4);
885 if (!freerdp_image_copy_from_icon_data(
886 argbPixels, PIXEL_FORMAT_ARGB32, 0, 0, 0,
887 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->width),
888 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->height), iconInfo->bitsColor,
889 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->cbBitsColor), iconInfo->bitsMask,
890 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->cbBitsMask), iconInfo->colorTable,
891 WINPR_ASSERTING_INT_CAST(UINT16, iconInfo->cbColorTable), iconInfo->bpp))
895 const UINT32 nelements = 2 + iconInfo->width * iconInfo->height;
896 pixels = realloc(railIcon->data, nelements *
sizeof(
long));
901 railIcon->data = pixels;
903 railIcon->length = WINPR_ASSERTING_INT_CAST(
int, nelements);
904 pixels[0] = iconInfo->width;
905 pixels[1] = iconInfo->height;
906 nextPixel = argbPixels;
908 for (UINT32 i = 2; i < nelements; i++)
910 pixels[i] = FreeRDPReadColor(nextPixel, PIXEL_FORMAT_BGRA32);
922static void xf_rail_set_window_icon(xfContext* xfc, xfAppWindow* railWindow, xfRailIcon* icon,
927 LogDynAndXChangeProperty(xfc->log, xfc->display, railWindow->handle, xfc->NET_WM_ICON,
928 XA_CARDINAL, 32, replace ? PropModeReplace : PropModeAppend,
929 (unsigned char*)icon->data, icon->length);
930 LogDynAndXFlush(xfc->log, xfc->display);
934static BOOL xf_rail_window_icon(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
938 xfContext* xfc = (xfContext*)context;
939 BOOL replaceIcon = 0;
940 xfAppWindow* railWindow = xf_rail_get_window(xfc, orderInfo->windowId, FALSE);
945 WINPR_ASSERT(windowIcon);
946 WINPR_ASSERT(windowIcon->iconInfo);
947 xfRailIcon* icon = RailIconCache_Lookup(
948 xfc->railIconCache, WINPR_ASSERTING_INT_CAST(UINT8, windowIcon->iconInfo->cacheId),
949 WINPR_ASSERTING_INT_CAST(UINT16, windowIcon->iconInfo->cacheEntry));
953 WLog_Print(xfc->log, WLOG_WARN,
"failed to get icon from cache %02X:%04X",
954 windowIcon->iconInfo->cacheId, windowIcon->iconInfo->cacheEntry);
956 else if (!convert_rail_icon(windowIcon->iconInfo, icon))
958 WLog_Print(xfc->log, WLOG_WARN,
"failed to convert icon for window %08X",
959 orderInfo->windowId);
963 replaceIcon = !!(orderInfo->fieldFlags & WINDOW_ORDER_STATE_NEW);
964 xf_rail_set_window_icon(xfc, railWindow, icon, replaceIcon);
967 xf_rail_return_window(railWindow, FALSE);
972static BOOL xf_rail_window_cached_icon(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
976 xfContext* xfc = (xfContext*)context;
977 WINPR_ASSERT(orderInfo);
979 BOOL replaceIcon = 0;
980 xfAppWindow* railWindow = xf_rail_get_window(xfc, orderInfo->windowId, FALSE);
985 WINPR_ASSERT(windowCachedIcon);
987 xfRailIcon* icon = RailIconCache_Lookup(
988 xfc->railIconCache, WINPR_ASSERTING_INT_CAST(UINT8, windowCachedIcon->cachedIcon.cacheId),
989 WINPR_ASSERTING_INT_CAST(UINT16, windowCachedIcon->cachedIcon.cacheEntry));
993 WLog_Print(xfc->log, WLOG_WARN,
"failed to get icon from cache %02X:%04X",
994 windowCachedIcon->cachedIcon.cacheId, windowCachedIcon->cachedIcon.cacheEntry);
998 replaceIcon = !!(orderInfo->fieldFlags & WINDOW_ORDER_STATE_NEW);
999 xf_rail_set_window_icon(xfc, railWindow, icon, replaceIcon);
1002 xf_rail_return_window(railWindow, FALSE);
1008xf_rail_notify_icon_common(WINPR_ATTR_UNUSED rdpContext* context,
1012 xfContext* xfc = (xfContext*)context;
1015 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1016 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_VERSION)
1020 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_TIP)
1024 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_INFO_TIP)
1028 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_NOTIFY_STATE)
1032 if (orderInfo->fieldFlags & WINDOW_ORDER_ICON)
1036 if (orderInfo->fieldFlags & WINDOW_ORDER_CACHED_ICON)
1044static BOOL xf_rail_notify_icon_create(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
1047 return xf_rail_notify_icon_common(context, orderInfo, notifyIconState);
1051static BOOL xf_rail_notify_icon_update(rdpContext* context,
const WINDOW_ORDER_INFO* orderInfo,
1054 return xf_rail_notify_icon_common(context, orderInfo, notifyIconState);
1058static BOOL xf_rail_notify_icon_delete(WINPR_ATTR_UNUSED rdpContext* context,
1061 xfContext* xfc = (xfContext*)context;
1064 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1070xf_rail_monitored_desktop(WINPR_ATTR_UNUSED rdpContext* context,
1074 const UINT32 mask = WINDOW_ORDER_TYPE_DESKTOP | WINDOW_ORDER_FIELD_DESKTOP_HOOKED |
1075 WINDOW_ORDER_FIELD_DESKTOP_ARC_BEGAN |
1076 WINDOW_ORDER_FIELD_DESKTOP_ARC_COMPLETED |
1077 WINDOW_ORDER_FIELD_DESKTOP_ACTIVE_WND | WINDOW_ORDER_FIELD_DESKTOP_ZORDER;
1078 xfContext* xfc = (xfContext*)context;
1080 if (!context || !orderInfo || !monitoredDesktop)
1083 if ((orderInfo->fieldFlags & WINDOW_ORDER_TYPE_DESKTOP) == 0)
1085 WLog_Print(xfc->log, WLOG_WARN,
"WINDOW_ORDER_TYPE_DESKTOP flag missing!");
1089 if ((orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ARC_BEGAN) &&
1090 (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_HOOKED))
1093 WLog_Print(xfc->log, WLOG_WARN,
1094 "TODO: implement WINDOW_ORDER_FIELD_DESKTOP_ARC_BEGAN && "
1095 "WINDOW_ORDER_FIELD_DESKTOP_HOOKED");
1097 else if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_HOOKED)
1099 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_HOOKED");
1101 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ARC_COMPLETED)
1103 WLog_Print(xfc->log, WLOG_DEBUG,
1104 "WINDOW_ORDER_FIELD_DESKTOP_ARC_COMPLETED -> switch to RAILS mode");
1105 if (!xf_rail_enable_remoteapp_mode(xfc))
1108 if (!xf_rail_select_workarea_events(xfc))
1113 if ((app !=
nullptr) && (strnlen(app, 1) > 0))
1115 if (client_rail_server_start_cmd(xfc->rail) != CHANNEL_RC_OK)
1117 if (xf_rail_send_workarea(xfc) != CHANNEL_RC_OK)
1121 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ACTIVE_WND)
1123 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_ACTIVE_WND");
1125 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_ZORDER)
1127 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_ZORDER");
1129 if (orderInfo->fieldFlags & ~mask)
1131 WLog_Print(xfc->log, WLOG_WARN,
"unknown flags 0x%08" PRIx32
"!", orderInfo->fieldFlags);
1137static BOOL xf_rail_non_monitored_desktop(rdpContext* context,
1140 xfContext* xfc = (xfContext*)context;
1141 const UINT32 mask = WINDOW_ORDER_TYPE_DESKTOP | WINDOW_ORDER_FIELD_DESKTOP_NONE;
1143 if (!context || !orderInfo)
1146 if ((orderInfo->fieldFlags & WINDOW_ORDER_TYPE_DESKTOP) == 0)
1148 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_TYPE_DESKTOP");
1151 if (orderInfo->fieldFlags & WINDOW_ORDER_FIELD_DESKTOP_NONE)
1153 WLog_Print(xfc->log, WLOG_WARN,
"TODO: implement WINDOW_ORDER_FIELD_DESKTOP_NONE");
1155 if (orderInfo->fieldFlags & ~mask)
1157 WLog_Print(xfc->log, WLOG_WARN,
"unknown flags 0x%08" PRIx32
"!", orderInfo->fieldFlags);
1160 return xf_rail_disable_remoteapp_mode(xfc);
1163static void xf_rail_register_update_callbacks(rdpUpdate* update)
1165 WINPR_ASSERT(update);
1167 rdpWindowUpdate* window = update->window;
1168 WINPR_ASSERT(window);
1170 window->WindowCreate = xf_rail_window_common;
1171 window->WindowUpdate = xf_rail_window_common;
1172 window->WindowDelete = xf_rail_window_delete;
1173 window->WindowIcon = xf_rail_window_icon;
1174 window->WindowCachedIcon = xf_rail_window_cached_icon;
1175 window->NotifyIconCreate = xf_rail_notify_icon_create;
1176 window->NotifyIconUpdate = xf_rail_notify_icon_update;
1177 window->NotifyIconDelete = xf_rail_notify_icon_delete;
1178 window->MonitoredDesktop = xf_rail_monitored_desktop;
1179 window->NonMonitoredDesktop = xf_rail_non_monitored_desktop;
1190static UINT xf_rail_server_execute_result(RailClientContext* context,
1193 WINPR_ASSERT(context);
1194 WINPR_ASSERT(execResult);
1196 xfContext* xfc = (xfContext*)context->custom;
1199 if (execResult->execResult != RAIL_EXEC_S_OK)
1202 xfc->log, WLOG_ERROR,
"RAIL exec error: execResult=%s [0x%08" PRIx32
"] NtError=0x%X\n",
1203 error_code2str(execResult->execResult), execResult->execResult, execResult->rawResult);
1204 freerdp_abort_connect_context(&xfc->common.context);
1207 return CHANNEL_RC_OK;
1216static UINT xf_rail_server_system_param(WINPR_ATTR_UNUSED RailClientContext* context,
1219 WINPR_ASSERT(context);
1221 xfContext* xfc = (xfContext*)context->custom;
1225 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1226 return CHANNEL_RC_OK;
1235static UINT xf_rail_server_local_move_size(RailClientContext* context,
1241 Window child_window = 0;
1242 WINPR_ASSERT(context);
1243 WINPR_ASSERT(localMoveSize);
1245 xfContext* xfc = (xfContext*)context->custom;
1246 xfAppWindow* appWindow = xf_rail_get_window(xfc, localMoveSize->windowId, FALSE);
1249 return ERROR_INTERNAL_ERROR;
1251 WLog_Print(xfc->log, WLOG_TRACE,
"%s [0x%08" PRIx32
"]",
1252 movetype2str(localMoveSize->moveSizeType), localMoveSize->moveSizeType);
1253 switch (localMoveSize->moveSizeType)
1255 case RAIL_WMSZ_LEFT:
1256 direction = NET_WM_MOVERESIZE_SIZE_LEFT;
1257 x = localMoveSize->posX;
1258 y = localMoveSize->posY;
1261 case RAIL_WMSZ_RIGHT:
1262 direction = NET_WM_MOVERESIZE_SIZE_RIGHT;
1263 x = localMoveSize->posX;
1264 y = localMoveSize->posY;
1268 direction = NET_WM_MOVERESIZE_SIZE_TOP;
1269 x = localMoveSize->posX;
1270 y = localMoveSize->posY;
1273 case RAIL_WMSZ_TOPLEFT:
1274 direction = NET_WM_MOVERESIZE_SIZE_TOPLEFT;
1275 x = localMoveSize->posX;
1276 y = localMoveSize->posY;
1279 case RAIL_WMSZ_TOPRIGHT:
1280 direction = NET_WM_MOVERESIZE_SIZE_TOPRIGHT;
1281 x = localMoveSize->posX;
1282 y = localMoveSize->posY;
1285 case RAIL_WMSZ_BOTTOM:
1286 direction = NET_WM_MOVERESIZE_SIZE_BOTTOM;
1287 x = localMoveSize->posX;
1288 y = localMoveSize->posY;
1291 case RAIL_WMSZ_BOTTOMLEFT:
1292 direction = NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT;
1293 x = localMoveSize->posX;
1294 y = localMoveSize->posY;
1297 case RAIL_WMSZ_BOTTOMRIGHT:
1298 direction = NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT;
1299 x = localMoveSize->posX;
1300 y = localMoveSize->posY;
1303 case RAIL_WMSZ_MOVE:
1304 direction = NET_WM_MOVERESIZE_MOVE;
1305 XTranslateCoordinates(xfc->display, appWindow->handle, RootWindowOfScreen(xfc->screen),
1306 localMoveSize->posX, localMoveSize->posY, &x, &y, &child_window);
1309 case RAIL_WMSZ_KEYMOVE:
1310 direction = NET_WM_MOVERESIZE_MOVE_KEYBOARD;
1311 x = localMoveSize->posX;
1312 y = localMoveSize->posY;
1316 case RAIL_WMSZ_KEYSIZE:
1317 direction = NET_WM_MOVERESIZE_SIZE_KEYBOARD;
1318 x = localMoveSize->posX;
1319 y = localMoveSize->posY;
1326 if (localMoveSize->isMoveSizeStart)
1327 xf_StartLocalMoveSize(xfc, appWindow, direction, x, y);
1329 xf_EndLocalMoveSize(xfc, appWindow);
1331 xf_rail_return_window(appWindow, FALSE);
1332 return CHANNEL_RC_OK;
1341static UINT xf_rail_server_min_max_info(RailClientContext* context,
1344 WINPR_ASSERT(context);
1345 WINPR_ASSERT(minMaxInfo);
1347 xfContext* xfc = (xfContext*)context->custom;
1348 xfAppWindow* appWindow = xf_rail_get_window(xfc, minMaxInfo->windowId, FALSE);
1352 xf_SetWindowMinMaxInfo(xfc, appWindow, minMaxInfo->maxWidth, minMaxInfo->maxHeight,
1353 minMaxInfo->maxPosX, minMaxInfo->maxPosY, minMaxInfo->minTrackWidth,
1354 minMaxInfo->minTrackHeight, minMaxInfo->maxTrackWidth,
1355 minMaxInfo->maxTrackHeight);
1357 xf_rail_return_window(appWindow, FALSE);
1359 return CHANNEL_RC_OK;
1369xf_rail_server_language_bar_info(WINPR_ATTR_UNUSED RailClientContext* context,
1372 WINPR_ASSERT(context);
1374 xfContext* xfc = (xfContext*)context->custom;
1377 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1378 return CHANNEL_RC_OK;
1388xf_rail_server_get_appid_response(WINPR_ATTR_UNUSED RailClientContext* context,
1391 WINPR_ASSERT(context);
1393 xfContext* xfc = (xfContext*)context->custom;
1396 WLog_Print(xfc->log, WLOG_ERROR,
"TODO: implement");
1397 return CHANNEL_RC_OK;
1401static BOOL rail_window_key_equals(
const void* key1,
const void* key2)
1403 const UINT64* k1 = (
const UINT64*)key1;
1404 const UINT64* k2 = (
const UINT64*)key2;
1413static UINT32 rail_window_key_hash(
const void* key)
1415 const UINT64* k1 = (
const UINT64*)key;
1419static void rail_window_free(
void* value)
1421 xfAppWindow* appWindow = (xfAppWindow*)value;
1426 xf_DestroyWindow(appWindow->xfc, appWindow);
1429int xf_rail_init(xfContext* xfc, RailClientContext* rail)
1431 rdpContext* context = (rdpContext*)xfc;
1437 xf_rail_register_update_callbacks(context->update);
1438 rail->custom = (
void*)xfc;
1439 rail->ServerExecuteResult = xf_rail_server_execute_result;
1440 rail->ServerSystemParam = xf_rail_server_system_param;
1441 rail->ServerLocalMoveSize = xf_rail_server_local_move_size;
1442 rail->ServerMinMaxInfo = xf_rail_server_min_max_info;
1443 rail->ServerLanguageBarInfo = xf_rail_server_language_bar_info;
1444 rail->ServerGetAppIdResponse = xf_rail_server_get_appid_response;
1445 xfc->railWindows = HashTable_New(TRUE);
1447 if (!xfc->railWindows)
1450 if (!HashTable_SetHashFunction(xfc->railWindows, rail_window_key_hash))
1453 wObject* obj = HashTable_KeyObject(xfc->railWindows);
1457 wObject* obj = HashTable_ValueObject(xfc->railWindows);
1460 xfc->railIconCache = RailIconCache_New(xfc->log, xfc->common.context.settings);
1462 if (!xfc->railIconCache)
1468 HashTable_Free(xfc->railWindows);
1472int xf_rail_uninit(xfContext* xfc, RailClientContext* rail)
1478 xfc->rail->custom =
nullptr;
1479 xfc->rail =
nullptr;
1482 if (xfc->railWindows)
1484 HashTable_Free(xfc->railWindows);
1485 xfc->railWindows =
nullptr;
1488 if (xfc->railIconCache)
1490 RailIconCache_Free(xfc->railIconCache);
1491 xfc->railIconCache =
nullptr;
1497xfAppWindow* xf_rail_add_window(xfContext* xfc, UINT64
id, INT32 x, INT32 y, UINT32 width,
1498 UINT32 height, UINT32 surfaceId)
1503 xfAppWindow* appWindow = (xfAppWindow*)calloc(1,
sizeof(xfAppWindow));
1508 appWindow->xfc = xfc;
1509 appWindow->windowId = id;
1510 appWindow->surfaceId = surfaceId;
1513 appWindow->width = WINPR_ASSERTING_INT_CAST(
int, width);
1514 appWindow->height = WINPR_ASSERTING_INT_CAST(
int, height);
1516 xf_AppWindowsLock(xfc);
1517 if (!xf_AppWindowCreate(xfc, appWindow))
1520 if (!HashTable_Insert(xfc->railWindows, &appWindow->windowId, (
void*)appWindow))
1524 rail_window_free(appWindow);
1525 xf_AppWindowsUnlock(xfc);
1529BOOL xf_rail_del_window(xfContext* xfc, UINT64
id)
1534 if (!xfc->railWindows)
1538 const BOOL res = HashTable_Remove(xfc->railWindows, &
id);
1543void xf_rail_return_windowFrom(xfAppWindow* window, BOOL alreadyLocked,
const char* file,
1544 const char* fkt,
size_t line)
1552 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