feat(clipboard): Linux + Windows host clipboard backends as the pf-clipboard crate (Phase 1 host + Phase 3)
ci / web (pull_request) Successful in 1m9s
apple / swift (pull_request) Successful in 1m19s
apple / screenshots (pull_request) Has been skipped
ci / docs-site (pull_request) Successful in 1m30s
windows / build (aarch64-pc-windows-msvc) (pull_request) Successful in 5m16s
ci / bench (pull_request) Successful in 6m8s
ci / rust (pull_request) Failing after 7m6s
windows / build (x86_64-pc-windows-msvc) (pull_request) Successful in 6m33s
android / android (pull_request) Successful in 12m39s
ci / web (pull_request) Successful in 1m9s
apple / swift (pull_request) Successful in 1m19s
apple / screenshots (pull_request) Has been skipped
ci / docs-site (pull_request) Successful in 1m30s
windows / build (aarch64-pc-windows-msvc) (pull_request) Successful in 5m16s
ci / bench (pull_request) Successful in 6m8s
ci / rust (pull_request) Failing after 7m6s
windows / build (x86_64-pc-windows-msvc) (pull_request) Successful in 6m33s
android / android (pull_request) Successful in 12m39s
The host half of the shared clipboard (design/clipboard-and-file-transfer.md §4),
ported from feat/shared-clipboard (6bd8c18b) into the post-W6 crate shape: the
backends land as a pf-clipboard subsystem crate (the pf-inject/pf-capture
pattern) instead of growing punktfunk-host back out, and the ~340-line
punktfunk1.rs integration is re-implemented against the native.rs/control.rs
split that replaced it.
pf-clipboard:
- host::wayland — ext-data-control-v1 (KWin / wlroots / Sway / Hyprland).
- host::mutter — GNOME via Mutter's *direct* org.gnome.Mutter.RemoteDesktop
clipboard (no data-control at any GNOME version; the xdg portal needs an
interactive grant a headless host can't answer).
- host::windows + host::winfmt — Win32 clipboard on a hidden message-loop
window: WM_CLIPBOARDUPDATE listener + OLE delayed rendering (WM_RENDERFORMAT)
for text / CF_HTML / RTF / PNG.
- host::session — the backend-agnostic coordinator bridging HostClipboard to
the QUIC clipboard plane (offers, fetch accept-loop, remote offers, pastes).
- A portable facade (policy / enabled / cap_advertised / ClipCoordCmd / start /
spawn_decline_loop) so the orchestrator compiles cfg-free on every platform;
ClipCoordCmd moves into the crate (it was host-owned before).
punktfunk-host glue:
- handshake.rs advertises HOST_CAP_CLIPBOARD via pf_clipboard::cap_advertised.
- serve_session starts the coordinator (gated on a real compositor — the
synthetic source stays out of the session clipboard) and spawns the
CLIP_FETCH_UNAVAILABLE decline loop when the policy is on but no backend bound.
- control.rs gains the ClipControl/ClipOffer arms + the host-offer forward
branch, and the e2e session test (cap advertise → ClipState ack with
BACKEND_UNAVAILABLE → fetch decline) rides in native.rs's tests.
Still opt-in default OFF (PUNKTFUNK_CLIPBOARD). Remaining: the macOS client
(design §5) — then this becomes user-visible.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -10,6 +10,10 @@ repository.workspace = true
|
||||
|
||||
[dependencies]
|
||||
punktfunk-core = { path = "../punktfunk-core", features = ["quic"] }
|
||||
# Shared clipboard (design/clipboard-and-file-transfer.md §4): the per-OS session-clipboard
|
||||
# backends + coordinator. Portable dep — the crate's facade (policy / ClipCoordCmd / start)
|
||||
# compiles everywhere; the backends are cfg-gated inside it.
|
||||
pf-clipboard = { path = "../pf-clipboard" }
|
||||
# M3 native control plane (the `punktfunk/1` QUIC handshake; data plane stays native-thread UDP).
|
||||
quinn = "0.11"
|
||||
anyhow = "1"
|
||||
|
||||
@@ -848,6 +848,17 @@ async fn serve_session(
|
||||
let fec_target_ctl = fec_target.clone();
|
||||
// The session's negotiated rate — the pin PyroWave retarget-refusals ack (§4.6).
|
||||
let session_bitrate_kbps = welcome.bitrate_kbps;
|
||||
// Shared-clipboard enable state (client `ClipControl` → host). The coordinator reads it to
|
||||
// decide whether to forward host copies; the control task flips it on each `ClipControl`.
|
||||
let clip_enabled = Arc::new(AtomicBool::new(false));
|
||||
// Start the host clipboard coordinator. On success it watches the session clipboard, forwards
|
||||
// host copies as `ClipOffer`s (`clip.offer_rx` → control task → client), installs client
|
||||
// offers as a lazy source, and owns the fetch-stream accept loop. `available` is false when
|
||||
// there's no backend (gamescope / older GNOME / an unsupported platform) — the control task
|
||||
// then answers `ClipControl` with `BACKEND_UNAVAILABLE` and the decline loop below handles
|
||||
// stray fetch streams.
|
||||
let clip = pf_clipboard::start(conn.clone(), clip_enabled.clone(), compositor.is_some()).await;
|
||||
let clip_available = clip.available;
|
||||
tokio::spawn(control::run(
|
||||
ctrl_send,
|
||||
ctrl_recv,
|
||||
@@ -864,7 +875,14 @@ async fn serve_session(
|
||||
probe_tx,
|
||||
probe_result_rx,
|
||||
reconfig_result_rx,
|
||||
clip_enabled,
|
||||
clip,
|
||||
));
|
||||
// Fetch streams with no backend behind them are answered `CLIP_FETCH_UNAVAILABLE` instead of
|
||||
// hanging (the coordinator owns `accept_bi` when a backend is live — exactly one consumer).
|
||||
if !clip_available && pf_clipboard::enabled() {
|
||||
pf_clipboard::spawn_decline_loop(conn.clone());
|
||||
}
|
||||
|
||||
// Input plane: QUIC datagrams → channel → a native per-session thread. Pointer/keyboard
|
||||
// events are forwarded to the host-lifetime [`InjectorService`] (`inj_tx`) so the portal
|
||||
@@ -1730,6 +1748,138 @@ mod tests {
|
||||
host.join().unwrap().unwrap();
|
||||
}
|
||||
|
||||
/// Shared clipboard end to end over a real synthetic session
|
||||
/// (`design/clipboard-and-file-transfer.md`): with the operator policy enabled, the host
|
||||
/// advertises the capability, acknowledges an enable with a `ClipState`, and — a synthetic
|
||||
/// session mirrors no compositor, so no clipboard backend binds — declines a fetch with an
|
||||
/// `Error` the client surfaces. Exercises the whole 0x40-0x44 control+fetch path across two real
|
||||
/// endpoints (client `NativeClient` ↔ host `serve_session`). The live-backend paths (a real
|
||||
/// compositor) are covered by the on-glass test against GNOME/Hyprland.
|
||||
#[test]
|
||||
fn clipboard_control_and_fetch_decline_over_session() {
|
||||
let _serial = SESSION_TEST_LOCK.lock().unwrap_or_else(|p| p.into_inner());
|
||||
use punktfunk_core::client::NativeClient;
|
||||
use punktfunk_core::clipboard::ClipEventCore;
|
||||
use punktfunk_core::quic::{
|
||||
CLIP_FILE_INDEX_NONE, CLIP_FLAG_FILES, CLIP_POLICY_FILES, HOST_CAP_CLIPBOARD,
|
||||
};
|
||||
|
||||
// Restore the env even on a panicking assert (the poisoned lock is recovered above, so a
|
||||
// leaked var could otherwise reach the next session test).
|
||||
struct EnvGuard(&'static str);
|
||||
impl Drop for EnvGuard {
|
||||
fn drop(&mut self) {
|
||||
std::env::remove_var(self.0);
|
||||
}
|
||||
}
|
||||
let _env = EnvGuard("PUNKTFUNK_CLIPBOARD");
|
||||
// Operator policy on. Session tests serialize on SESSION_TEST_LOCK, and only the session
|
||||
// path (a session test) reads this env, so the mutation is race-free here.
|
||||
std::env::set_var("PUNKTFUNK_CLIPBOARD", "1");
|
||||
|
||||
let host = std::thread::spawn(|| {
|
||||
run(Punktfunk1Options {
|
||||
port: 19781,
|
||||
source: Punktfunk1Source::Synthetic,
|
||||
seconds: 0,
|
||||
frames: 600, // keep the session alive well past the control exchange
|
||||
max_sessions: 1,
|
||||
max_concurrent: 1,
|
||||
require_pairing: false,
|
||||
allow_pairing: false,
|
||||
pairing_pin: None,
|
||||
paired_store: None,
|
||||
data_port: None,
|
||||
idle_timeout: None,
|
||||
mdns: false,
|
||||
})
|
||||
});
|
||||
std::thread::sleep(std::time::Duration::from_millis(500));
|
||||
|
||||
let mode = punktfunk_core::Mode {
|
||||
width: 1280,
|
||||
height: 720,
|
||||
refresh_hz: 60,
|
||||
};
|
||||
let client = NativeClient::connect(
|
||||
"127.0.0.1",
|
||||
19781,
|
||||
mode,
|
||||
CompositorPref::Auto,
|
||||
GamepadPref::Auto,
|
||||
0, // bitrate_kbps
|
||||
0, // video_caps
|
||||
2, // audio_channels
|
||||
0, // video_codecs (HEVC-only)
|
||||
0, // preferred_codec
|
||||
None, // display_hdr
|
||||
None, // launch
|
||||
None, // pin (TOFU)
|
||||
None, // identity (host doesn't require pairing)
|
||||
std::time::Duration::from_secs(10),
|
||||
)
|
||||
.expect("client connects to synthetic host");
|
||||
|
||||
assert_ne!(
|
||||
client.host_caps() & HOST_CAP_CLIPBOARD,
|
||||
0,
|
||||
"an enabled host advertises HOST_CAP_CLIPBOARD"
|
||||
);
|
||||
|
||||
// A bounded poll over the clipboard event plane.
|
||||
let poll = |pred: &dyn Fn(&ClipEventCore) -> bool| -> Option<ClipEventCore> {
|
||||
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(5);
|
||||
while std::time::Instant::now() < deadline {
|
||||
match client.next_clip(std::time::Duration::from_millis(200)) {
|
||||
Ok(ev) if pred(&ev) => return Some(ev),
|
||||
Ok(_) => {}
|
||||
Err(punktfunk_core::PunktfunkError::NoFrame) => {}
|
||||
Err(_) => break, // session closed
|
||||
}
|
||||
}
|
||||
None
|
||||
};
|
||||
|
||||
// Enable sync (requesting files) → the host acks with a ClipState. A synthetic session
|
||||
// mirrors no compositor, so no clipboard backend binds: the host refuses the enable with
|
||||
// `BACKEND_UNAVAILABLE` while still reporting the operator policy (files permitted).
|
||||
client.clip_control(true, CLIP_FLAG_FILES).unwrap();
|
||||
let state = poll(&|e| matches!(e, ClipEventCore::State { .. }))
|
||||
.expect("host replies with a ClipState ack");
|
||||
match state {
|
||||
ClipEventCore::State {
|
||||
enabled,
|
||||
policy,
|
||||
reason,
|
||||
} => {
|
||||
assert!(!enabled, "no backend for a synthetic session → not enabled");
|
||||
assert_eq!(
|
||||
reason,
|
||||
punktfunk_core::quic::CLIP_REASON_BACKEND_UNAVAILABLE,
|
||||
"the refusal reason is BACKEND_UNAVAILABLE"
|
||||
);
|
||||
assert_ne!(
|
||||
policy & CLIP_POLICY_FILES,
|
||||
0,
|
||||
"PUNKTFUNK_CLIPBOARD=1 permits files"
|
||||
);
|
||||
}
|
||||
_ => unreachable!(),
|
||||
}
|
||||
|
||||
// Fetch the host clipboard: a synthetic session has no backend, so the host declines and
|
||||
// the client surfaces an Error for that transfer id.
|
||||
let xfer = client
|
||||
.clip_fetch(1, "text/plain;charset=utf-8".into(), CLIP_FILE_INDEX_NONE)
|
||||
.unwrap();
|
||||
let err = poll(&|e| matches!(e, ClipEventCore::Error { id, .. } if *id == xfer))
|
||||
.expect("host declines the fetch (no backend) → Error event");
|
||||
assert!(matches!(err, ClipEventCore::Error { .. }));
|
||||
|
||||
drop(client);
|
||||
host.join().unwrap().unwrap();
|
||||
}
|
||||
|
||||
fn test_paired_path() -> std::path::PathBuf {
|
||||
std::env::temp_dir().join(format!("punktfunk-paired-test-{}.json", std::process::id()))
|
||||
}
|
||||
|
||||
@@ -6,10 +6,13 @@
|
||||
//! the data-plane thread over the session's mpsc bridges.
|
||||
|
||||
use super::*;
|
||||
use pf_clipboard::ClipCoordCmd;
|
||||
use punktfunk_core::quic::{ClipControl, ClipOffer, ClipState};
|
||||
|
||||
/// Run the control task for one live session. Owns the control streams (`serve_session` hands them
|
||||
/// off after negotiation) plus every channel end that bridges to the data-plane thread. Returns
|
||||
/// when the control stream closes or a data-plane channel drops.
|
||||
/// off after negotiation) plus every channel end that bridges to the data-plane thread, and the
|
||||
/// [`pf_clipboard::ClipCoord`] handle bridging to the clipboard coordinator. Returns when the
|
||||
/// control stream closes or a data-plane channel drops.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
pub(super) async fn run(
|
||||
mut ctrl_send: quinn::SendStream,
|
||||
@@ -27,7 +30,17 @@ pub(super) async fn run(
|
||||
probe_tx: std::sync::mpsc::Sender<ProbeRequest>,
|
||||
mut probe_result_rx: tokio::sync::mpsc::UnboundedReceiver<ProbeResult>,
|
||||
mut reconfig_result_rx: tokio::sync::mpsc::UnboundedReceiver<Reconfigured>,
|
||||
clip_enabled: Arc<AtomicBool>,
|
||||
clip: pf_clipboard::ClipCoord,
|
||||
) {
|
||||
let pf_clipboard::ClipCoord {
|
||||
available: clip_available,
|
||||
cmd_tx: clip_cmd_tx,
|
||||
offer_rx: mut clip_offer_rx,
|
||||
} = clip;
|
||||
// Set once `clip_offer_rx` closes (coordinator gone / inert handle) so its `select!` branch
|
||||
// stops firing on a perpetually-ready `None`.
|
||||
let mut clip_offer_closed = false;
|
||||
let mut active = initial_mode;
|
||||
// Host-side switch rate limit (a backstop against a hostile/broken client spamming
|
||||
// Reconfigure into pipeline-rebuild churn — the drain-to-newest in the data plane already
|
||||
@@ -180,6 +193,61 @@ pub(super) async fn run(
|
||||
if io::write_msg(&mut ctrl_send, &echo.encode()).await.is_err() {
|
||||
break;
|
||||
}
|
||||
} else if let Ok(ctl) = ClipControl::decode(&msg) {
|
||||
// Shared clipboard enable/disable (design/clipboard-and-file-transfer.md
|
||||
// §3.1). Reply with the resolved state; the operator policy is authoritative
|
||||
// over the client's request. When the policy allows it but no backend bound
|
||||
// (gamescope / older GNOME), enable is refused with BACKEND_UNAVAILABLE so the
|
||||
// client can say *why*. The resolved `enabled` gates the coordinator.
|
||||
let policy = pf_clipboard::policy();
|
||||
let (enabled, resolved_policy, reason) = match policy {
|
||||
None => (false, 0, punktfunk_core::quic::CLIP_REASON_POLICY_DISABLED),
|
||||
Some(p) if ctl.enabled && !clip_available => {
|
||||
(false, p, punktfunk_core::quic::CLIP_REASON_BACKEND_UNAVAILABLE)
|
||||
}
|
||||
Some(p) => {
|
||||
let files_ok = p & punktfunk_core::quic::CLIP_POLICY_FILES != 0;
|
||||
let wants_files =
|
||||
ctl.flags & punktfunk_core::quic::CLIP_FLAG_FILES != 0;
|
||||
let reason = if wants_files && !files_ok {
|
||||
punktfunk_core::quic::CLIP_REASON_NO_FILES
|
||||
} else {
|
||||
punktfunk_core::quic::CLIP_REASON_OK
|
||||
};
|
||||
(ctl.enabled, p, reason)
|
||||
}
|
||||
};
|
||||
clip_enabled.store(enabled, Ordering::SeqCst);
|
||||
// Drive the coordinator: enable re-announces the current host clipboard,
|
||||
// disable drops any selection we own. A dropped send (inert handle) is fine.
|
||||
let _ = clip_cmd_tx.send(ClipCoordCmd::SetEnabled(enabled));
|
||||
tracing::info!(
|
||||
enabled,
|
||||
files = enabled
|
||||
&& resolved_policy & punktfunk_core::quic::CLIP_POLICY_FILES != 0,
|
||||
"clipboard control"
|
||||
);
|
||||
let state = ClipState {
|
||||
enabled,
|
||||
policy: resolved_policy,
|
||||
reason,
|
||||
};
|
||||
if io::write_msg(&mut ctrl_send, &state.encode()).await.is_err() {
|
||||
break;
|
||||
}
|
||||
} else if let Ok(offer) = ClipOffer::decode(&msg) {
|
||||
// The client copied: hand its lazy format list to the coordinator, which
|
||||
// installs a host-side source that fetches from the client on host paste.
|
||||
tracing::debug!(
|
||||
seq = offer.seq,
|
||||
kinds = offer.kinds.len(),
|
||||
"clipboard offer from client"
|
||||
);
|
||||
let mimes = offer.kinds.iter().map(|k| k.mime.clone()).collect();
|
||||
let _ = clip_cmd_tx.send(ClipCoordCmd::RemoteOffer {
|
||||
seq: offer.seq,
|
||||
mimes,
|
||||
});
|
||||
} else {
|
||||
tracing::warn!("unknown control message — ignoring");
|
||||
}
|
||||
@@ -190,6 +258,21 @@ pub(super) async fn run(
|
||||
break;
|
||||
}
|
||||
}
|
||||
offer = clip_offer_rx.recv(), if !clip_offer_closed => {
|
||||
// Host copied → the coordinator minted a `ClipOffer`; forward it to the client
|
||||
// (only while sync is on — a race with a just-received disable would otherwise
|
||||
// leak a stale offer). `None` = coordinator gone; disable this branch.
|
||||
match offer {
|
||||
Some(offer) => {
|
||||
if clip_enabled.load(Ordering::SeqCst)
|
||||
&& io::write_msg(&mut ctrl_send, &offer.encode()).await.is_err()
|
||||
{
|
||||
break;
|
||||
}
|
||||
}
|
||||
None => clip_offer_closed = true,
|
||||
}
|
||||
}
|
||||
correction = reconfig_result_rx.recv() => {
|
||||
// H2 rollback/correction ack: the data plane reports the mode ACTUALLY live
|
||||
// after a rebuild that failed (stayed at the old mode) or that the backend
|
||||
|
||||
@@ -365,8 +365,16 @@ pub(super) async fn negotiate(
|
||||
// assuming HEVC.
|
||||
codec: codec_bit,
|
||||
// This host applies sequence-gated gamepad-state snapshots (InputKind::GamepadState),
|
||||
// so capable clients send those instead of the loss-fragile per-transition events.
|
||||
host_caps: punktfunk_core::quic::HOST_CAP_GAMEPAD_STATE,
|
||||
// so capable clients send those instead of the loss-fragile per-transition events. The
|
||||
// clipboard bit is advertised only when the operator policy enables it (design
|
||||
// clipboard-and-file-transfer.md §3.1) AND this platform has a backend — see
|
||||
// `pf_clipboard::cap_advertised` for the deliberate compositor-lacks-data-control case.
|
||||
host_caps: punktfunk_core::quic::HOST_CAP_GAMEPAD_STATE
|
||||
| if pf_clipboard::cap_advertised() {
|
||||
punktfunk_core::quic::HOST_CAP_CLIPBOARD
|
||||
} else {
|
||||
0
|
||||
},
|
||||
};
|
||||
io::write_msg(send, &welcome.encode()).await?;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user