Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support changing the mouse pointer #37882

Merged
merged 15 commits into from
Feb 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/srv/desktop/rdp/rdpclient/src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1123,7 +1123,7 @@ fn create_config(width: u16, height: u16, pin: String) -> Config {
// https://github.com/FreeRDP/FreeRDP/blob/4e24b966c86fdf494a782f0dfcfc43a057a2ea60/libfreerdp/core/settings.c#LL49C34-L49C70
client_dir: "C:\\Windows\\System32\\mstscax.dll".to_string(),
platform: MajorPlatformType::UNSPECIFIED,
no_server_pointer: true,
no_server_pointer: false,
autologon: true,
pointer_software_rendering: false,
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ export function DesktopSession(props: State) {
canvasOnMouseUp={canvasOnMouseUp}
canvasOnMouseWheelScroll={canvasOnMouseWheelScroll}
canvasOnContextMenu={canvasOnContextMenu}
updatePointer={true}
/>
</Flex>
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ function TdpClientCanvas(props: Props) {
canvasOnMouseWheelScroll,
canvasOnContextMenu,
style,
updatePointer,
} = props;
const canvasRef = useRef<HTMLCanvasElement>(null);

Expand Down Expand Up @@ -98,6 +99,44 @@ function TdpClientCanvas(props: Props) {
}
}, [client, clientOnPngFrame]);

const previousCursor = useRef('auto');

useEffect(() => {
if (client && updatePointer) {
const canvas = canvasRef.current;
const updatePointer = (pointer: {
data: ImageData | boolean;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd add a short JSDoc comment explaining that if data is boolean then true means that we want to show a cursor and false means we want to hide it.

hotspot_x?: number;
hotspot_y?: number;
}) => {
if (typeof pointer.data === 'boolean') {
if (pointer.data) {
canvas.style.cursor = previousCursor.current;
} else {
previousCursor.current = canvas.style.cursor;
canvas.style.cursor = 'none';
}
return;
}
const cursor = document.createElement('canvas');
cursor.width = pointer.data.width;
cursor.height = pointer.data.height;
cursor
.getContext('2d', { colorSpace: pointer.data.colorSpace })
.putImageData(pointer.data, 0, 0);
canvas.style.cursor = `url(${cursor.toDataURL()}) ${
pointer.hotspot_x
} ${pointer.hotspot_y}, auto`;
};

client.addListener(TdpClientEvent.POINTER, updatePointer);

return () => {
client.removeListener(TdpClientEvent.POINTER, updatePointer);
};
}
}, [client, updatePointer]);

useEffect(() => {
if (client && clientOnBmpFrame) {
const canvas = canvasRef.current;
Expand Down Expand Up @@ -401,6 +440,7 @@ export type Props = {
canvasOnMouseWheelScroll?: (cli: TdpClient, e: WheelEvent) => void;
canvasOnContextMenu?: () => boolean;
style?: CSSProperties;
updatePointer?: boolean;
};

export default memo(TdpClientCanvas);
47 changes: 41 additions & 6 deletions web/packages/teleport/src/ironrdp/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ impl FastPathProcessor {
user_channel_id,
// These should be set to the same values as they're set to in the
// `Config` object in lib/srv/desktop/rdp/rdpclient/src/client.rs.
no_server_pointer: true,
no_server_pointer: false,
pointer_software_rendering: false,
zmb3 marked this conversation as resolved.
Show resolved Hide resolved
}
.build(),
Expand All @@ -178,12 +178,17 @@ impl FastPathProcessor {
/// `draw_cb: (bitmapFrame: BitmapFrame) => void`
///
/// `respond_cb: (responseFrame: ArrayBuffer) => void`
///
/// `update_pointer_cb: (data: ImageData | boolean, hotspot_x: number, hotspot_y: number) => void`
/// if data is `false` we hide cursor but remember its value, if data is `true` we restore last
/// cursor value, otherwise we set cursor to bitmapt from `ImageData`
pub fn process(
&mut self,
tdp_fast_path_frame: &[u8],
cb_context: &JsValue,
draw_cb: &js_sys::Function,
respond_cb: &js_sys::Function,
update_pointer_cb: &js_sys::Function,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's document the signature of this function like we do for the others

/// `tdp_fast_path_frame: Uint8Array`
///
/// `cb_context: tdp.Client`
///
/// `draw_cb: (bitmapFrame: BitmapFrame) => void`
///
/// `respond_cb: (responseFrame: ArrayBuffer) => void`

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might also be worth documenting the meanings of the different options for the data param.

) -> Result<(), JsValue> {
self.check_remote_fx(tdp_fast_path_frame)?;

Expand Down Expand Up @@ -211,13 +216,19 @@ impl FastPathProcessor {
UpdateKind::Region(region) => {
outputs.push(ActiveStageOutput::GraphicsUpdate(region));
}
UpdateKind::PointerDefault
| UpdateKind::PointerHidden
| UpdateKind::PointerPosition { .. }
| UpdateKind::PointerBitmap(_) => {
warn!("Pointer updates are not supported");
UpdateKind::PointerDefault => {
outputs.push(ActiveStageOutput::PointerDefault);
}
UpdateKind::PointerHidden => {
outputs.push(ActiveStageOutput::PointerHidden);
}
UpdateKind::PointerPosition { .. } => {
warn!("Pointer position updates are not supported");
continue;
}
UpdateKind::PointerBitmap(pointer) => {
outputs.push(ActiveStageOutput::PointerBitmap(pointer))
}
}
}

Expand All @@ -240,6 +251,30 @@ impl FastPathProcessor {
ActiveStageOutput::Terminate(_) => {
return Err(JsValue::from_str("Terminate should never be returned"));
}
ActiveStageOutput::PointerBitmap(pointer) => {
let data = &pointer.bitmap_data;
let image_data = create_image_data_from_image_and_region(
data,
InclusiveRectangle {
left: 0,
top: 0,
right: pointer.width - 1,
bottom: pointer.height - 1,
},
)?;
update_pointer_cb.call3(
cb_context,
&JsValue::from(image_data),
&JsValue::from(pointer.hotspot_x),
&JsValue::from(pointer.hotspot_y),
)?;
}
ActiveStageOutput::PointerDefault => {
update_pointer_cb.call1(cb_context, &JsValue::from(true))?;
}
ActiveStageOutput::PointerHidden => {
update_pointer_cb.call1(cb_context, &JsValue::from(false))?;
}
_ => {
debug!("Unhandled ActiveStageOutput: {:?}", output);
}
Expand Down
4 changes: 4 additions & 0 deletions web/packages/teleport/src/lib/tdp/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ export enum TdpClientEvent {
WS_OPEN = 'ws open',
WS_CLOSE = 'ws close',
RESET = 'reset',
POINTER = 'pointer',
}

export enum LogType {
Expand Down Expand Up @@ -357,6 +358,9 @@ export default class Client extends EventEmitterWebAuthnSender {
},
(responseFrame: ArrayBuffer) => {
this.sendRDPResponsePDU(responseFrame);
},
(data: ImageData | boolean, hotspot_x?: number, hotspot_y?: number) => {
this.emit(TdpClientEvent.POINTER, { data, hotspot_x, hotspot_y });
}
);
} catch (e) {
Expand Down