fix(web)!: replace current clipboard logic with auto and manual clipboard modes (#935)

Adds:
- auto clipboard mode. 
  When it's enabled, the clipboard will be automatically monitored for
  changes, and updates from the server will be automatically saved to the
  local clipboard (this is the old logic; nothing has changed).
- manual clipboard mode. 
  One calls dedicated functions to interact with the clipboard.

Author: RRRadicalEdward

crates/iron-remote-desktop/src/lib.rs

@@ -267,16 +267,6 @@ macro_rules! make_bridge {
                 ))
             }
 
-            #[wasm_bindgen(js_name = remoteReceivedFormatListCallback)]
-            pub fn remote_received_format_list_callback(
-                &self,
-                callback: $crate::internal::web_sys::js_sys::Function,
-            ) -> Self {
-                Self($crate::SessionBuilder::remote_received_format_list_callback(
-                    &self.0, callback,
-                ))
-            }
-
             #[wasm_bindgen(js_name = forceClipboardUpdateCallback)]
             pub fn force_clipboard_update_callback(
                 &self,

crates/iron-remote-desktop/src/session.rs

@@ -45,9 +45,6 @@ pub trait SessionBuilder {
     #[must_use]
     fn remote_clipboard_changed_callback(&self, callback: js_sys::Function) -> Self;
 
-    #[must_use]
-    fn remote_received_format_list_callback(&self, callback: js_sys::Function) -> Self;
-
     #[must_use]
     fn force_clipboard_update_callback(&self, callback: js_sys::Function) -> Self;
 

crates/ironrdp-cliprdr/src/backend.rs

@@ -73,18 +73,6 @@ pub trait CliprdrBackend: AsAny + core::fmt::Debug + Send {
     /// client's clipboard prior to `CLIPRDR` SVC initialization.
     fn on_request_format_list(&mut self);
 
-    /// Called by [crate::Cliprdr] when copy sequence is finished.
-    /// This method is called after remote returns format list response.
-    ///
-    /// Useful for the backend implementations which need to know when remote is ready to paste
-    /// previously advertised formats from the client. E.g. Web client uses this for
-    /// Firefox-specific logic to delay sending keyboard key events to prevent pasting the old
-    /// data from the clipboard.
-    ///
-    /// This method has default implementation which does nothing because it is not required for
-    /// most of the backends.
-    fn on_format_list_received(&mut self) {}
-
     /// Adjusts [crate::Cliprdr] backend capabilities based on capabilities negotiated with a server.
     ///
     /// Called by [crate::Cliprdr] when capability negotiation is finished and server capabilities are

crates/ironrdp-cliprdr/src/lib.rs

@@ -166,8 +166,6 @@ impl<R: Role> Cliprdr<R> {
                         info!("CLIPRDR(clipboard) Remote has received format list successfully");
                     }
                 }
-
-                self.backend.on_format_list_received();
             }
             FormatListResponse::Fail => {
                 return self.handle_error_transition(ClipboardError::FormatListRejected);

crates/ironrdp-web/src/clipboard.rs

@@ -105,7 +105,6 @@ pub(crate) enum WasmClipboardBackendMessage {
     RemoteClipboardChanged(Vec<ClipboardFormat>),
     RemoteDataResponse(FormatDataResponse<'static>),
 
-    FormatListReceived,
     ForceClipboardUpdate,
 }
 
@@ -125,7 +124,6 @@ pub(crate) struct WasmClipboard {
 /// Callbacks, required to interact with JS code from within the backend.
 pub(crate) struct JsClipboardCallbacks {
     pub(crate) on_remote_clipboard_changed: js_sys::Function,
-    pub(crate) on_remote_received_format_list: Option<js_sys::Function>,
     pub(crate) on_force_clipboard_update: Option<js_sys::Function>,
 }
 
@@ -496,11 +494,6 @@ impl WasmClipboard {
                     }
                 }
             }
-            WasmClipboardBackendMessage::FormatListReceived => {
-                if let Some(callback) = self.js_callbacks.on_remote_received_format_list.as_mut() {
-                    callback.call0(&JsValue::NULL).expect("failed to call JS callback");
-                }
-            }
             WasmClipboardBackendMessage::ForceClipboardUpdate => {
                 if let Some(callback) = self.js_callbacks.on_force_clipboard_update.as_mut() {
                     callback.call0(&JsValue::NULL).expect("failed to call JS callback");
@@ -548,10 +541,6 @@ impl CliprdrBackend for WasmClipboardBackend {
         self.send_event(WasmClipboardBackendMessage::ForceClipboardUpdate);
     }
 
-    fn on_format_list_received(&mut self) {
-        self.send_event(WasmClipboardBackendMessage::FormatListReceived);
-    }
-
     fn on_process_negotiated_capabilities(&mut self, _: ClipboardGeneralCapabilityFlags) {
         // No additional capabilities yet
     }

crates/ironrdp-web/src/session.rs

@@ -65,7 +65,6 @@ struct SessionBuilderInner {
     set_cursor_style_callback: Option<js_sys::Function>,
     set_cursor_style_callback_context: Option<JsValue>,
     remote_clipboard_changed_callback: Option<js_sys::Function>,
-    remote_received_format_list_callback: Option<js_sys::Function>,
     force_clipboard_update_callback: Option<js_sys::Function>,
 
     use_display_control: bool,
@@ -94,7 +93,6 @@ impl Default for SessionBuilderInner {
             set_cursor_style_callback: None,
             set_cursor_style_callback_context: None,
             remote_clipboard_changed_callback: None,
-            remote_received_format_list_callback: None,
             force_clipboard_update_callback: None,
 
             use_display_control: false,
@@ -198,12 +196,6 @@ impl iron_remote_desktop::SessionBuilder for SessionBuilder {
         self.clone()
     }
 
-    /// Optional
-    fn remote_received_format_list_callback(&self, callback: js_sys::Function) -> Self {
-        self.0.borrow_mut().remote_received_format_list_callback = Some(callback);
-        self.clone()
-    }
-
     /// Optional
     fn force_clipboard_update_callback(&self, callback: js_sys::Function) -> Self {
         self.0.borrow_mut().force_clipboard_update_callback = Some(callback);
@@ -253,7 +245,6 @@ impl iron_remote_desktop::SessionBuilder for SessionBuilder {
             set_cursor_style_callback,
             set_cursor_style_callback_context,
             remote_clipboard_changed_callback,
-            remote_received_format_list_callback,
             force_clipboard_update_callback,
             outbound_message_size_limit,
         );
@@ -283,7 +274,6 @@ impl iron_remote_desktop::SessionBuilder for SessionBuilder {
                 .clone()
                 .context("set_cursor_style_callback_context missing")?;
             remote_clipboard_changed_callback = inner.remote_clipboard_changed_callback.clone();
-            remote_received_format_list_callback = inner.remote_received_format_list_callback.clone();
             force_clipboard_update_callback = inner.force_clipboard_update_callback.clone();
             outbound_message_size_limit = inner.outbound_message_size_limit;
         }
@@ -302,7 +292,6 @@ impl iron_remote_desktop::SessionBuilder for SessionBuilder {
                 clipboard::WasmClipboardMessageProxy::new(input_events_tx.clone()),
                 clipboard::JsClipboardCallbacks {
                     on_remote_clipboard_changed: callback,
-                    on_remote_received_format_list: remote_received_format_list_callback,
                     on_force_clipboard_update: force_clipboard_update_callback,
                 },
             )

web-client/iron-remote-desktop/src/enums/SessionEventType.ts

@@ -2,4 +2,7 @@
     STARTED,
     TERMINATED,
     ERROR,
+
+    // Clipboard events
+    CLIPBOARD_REMOTE_UPDATE,
 }

web-client/iron-remote-desktop/src/interfaces/UserInteraction.ts

@@ -31,5 +31,11 @@ export interface UserInteraction {
 
     setEnableClipboard(enable: boolean): void;
 
+    setEnableAutoClipboard(enable: boolean): void;
+
+    saveRemoteClipboardData(): Promise<boolean>;
+
+    sendClipboardData(): Promise<boolean>;
+
     invokeExtension(ext: Extension): void;
 }