rmux-server 0.7.0

Tokio daemon and request dispatcher for the RMUX terminal multiplexer.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use rmux_core::{key_code_lookup_bits, key_string_lookup_key, key_string_lookup_string};
use rmux_proto::{
    ErrorResponse, OptionName, PaneTarget, Response, RmuxError, SendKeysResponse,
    SendPrefixResponse,
};

use super::super::RequestHandler;
use super::{
    encode_key_for_target, encode_mouse_for_target, encode_tokens_for_target,
    expand_send_key_tokens, pane_id_for_input_target, prepare_pane_input_write,
    prepare_synchronized_pane_input_writes, resolve_input_target, write_bytes_to_targets,
    PaneInputWrite,
};
use crate::keys::{parse_key_code, resolve_hex_key};
use crate::limits::bounded_repeat_count;

impl RequestHandler {
    pub(in crate::handler) async fn handle_send_keys(
        &self,
        request: rmux_proto::SendKeysRequest,
    ) -> Response {
        let key_count = request.keys.len();
        if key_count == 0 {
            let state = self.state.lock().await;
            if let Err(error) = pane_id_for_input_target(&state, &request.target) {
                return Response::Error(ErrorResponse { error });
            }
            return Response::SendKeys(SendKeysResponse { key_count });
        }
        let keys = if request.keys.is_empty() {
            request.keys
        } else {
            match self
                .consume_copy_mode_key_tokens(std::process::id(), &request.target, &request.keys)
                .await
            {
                Ok(keys) => keys,
                Err(error) => return Response::Error(ErrorResponse { error }),
            }
        };
        if key_count > 0 && keys.is_empty() {
            return Response::SendKeys(SendKeysResponse { key_count });
        }
        let prepared = {
            let mut state = self.state.lock().await;
            let resolved = match encode_tokens_for_target(&state, &request.target, &keys) {
                Ok(resolved) => resolved,
                Err(error) => return Response::Error(ErrorResponse { error }),
            };
            let writes = match prepare_synchronized_pane_input_writes(
                &mut state,
                &request.target,
                &resolved,
            ) {
                Ok(writes) => writes,
                Err(error) => return Response::Error(ErrorResponse { error }),
            };
            (writes, resolved)
        };
        self.write_pane_input_and_mark_interactive(prepared.0, prepared.1, key_count)
            .await
    }

    #[async_recursion::async_recursion]
    pub(in crate::handler) async fn handle_send_keys_ext(
        &self,
        requester_pid: u32,
        request: rmux_proto::SendKeysExtRequest,
    ) -> Response {
        self.handle_send_keys_ext_inner(requester_pid, request, None)
            .await
    }

    pub(in crate::handler) async fn handle_send_keys_ext2(
        &self,
        requester_pid: u32,
        request: rmux_proto::SendKeysExt2Request,
    ) -> Response {
        let target_client = request.target_client;
        let request = rmux_proto::SendKeysExtRequest {
            target: request.target,
            keys: request.keys,
            expand_formats: request.expand_formats,
            hex: request.hex,
            literal: request.literal,
            dispatch_key_table: request.dispatch_key_table,
            copy_mode_command: request.copy_mode_command,
            forward_mouse_event: request.forward_mouse_event,
            reset_terminal: request.reset_terminal,
            repeat_count: request.repeat_count,
        };
        self.handle_send_keys_ext_inner(requester_pid, request, target_client)
            .await
    }

    #[async_recursion::async_recursion]
    async fn handle_send_keys_ext_inner(
        &self,
        requester_pid: u32,
        request: rmux_proto::SendKeysExtRequest,
        target_client: Option<String>,
    ) -> Response {
        let target_attach_pid = match target_client.as_deref() {
            Some(target_client) => match self
                .find_target_attach_client_pid(requester_pid, target_client, "send-keys")
                .await
            {
                Ok(Some(attach_pid)) => Some(attach_pid),
                Ok(None) => {
                    return Response::SendKeys(SendKeysResponse { key_count: 0 });
                }
                Err(error) => return Response::Error(ErrorResponse { error }),
            },
            None => None,
        };
        let attached_session = {
            let active_attach = self.active_attach.lock().await;
            active_attach.current_session_candidate(target_attach_pid.unwrap_or(requester_pid))
        };
        let target = {
            let state = self.state.lock().await;
            match resolve_input_target(&state, request.target.as_ref(), attached_session.as_ref()) {
                Ok(target) => target,
                Err(error) => return Response::Error(ErrorResponse { error }),
            }
        };

        let tokens = {
            let state = self.state.lock().await;
            match expand_send_key_tokens(&state, &target, &request.keys, request.expand_formats) {
                Ok(tokens) => tokens,
                Err(error) => return Response::Error(ErrorResponse { error }),
            }
        };

        if request.copy_mode_command {
            return Box::pin(self.handle_send_keys_copy_mode(
                target_attach_pid.unwrap_or(requester_pid),
                &request,
                target,
                &tokens,
            ))
            .await;
        }

        if request.dispatch_key_table {
            let attach_pid = match target_attach_pid {
                Some(attach_pid) => attach_pid,
                None => match self
                    .resolve_attached_client_pid(requester_pid, "send-keys")
                    .await
                {
                    Ok(attach_pid) => attach_pid,
                    Err(error) => return Response::Error(ErrorResponse { error }),
                },
            };
            let effective_requester_pid = target_attach_pid.unwrap_or(requester_pid);
            let repeat_count = bounded_repeat_count(request.repeat_count);
            for token in &tokens {
                let key = if request.hex {
                    resolve_hex_key(token).map(u64::from)
                } else {
                    parse_key_code(token)
                };
                let Some(key) = key else {
                    return Response::Error(ErrorResponse {
                        error: RmuxError::Server(format!("unknown key: {token}")),
                    });
                };
                for _ in 0..repeat_count {
                    if let Err(error) = Box::pin(self.dispatch_attached_key(
                        attach_pid,
                        effective_requester_pid,
                        &target,
                        key,
                    ))
                    .await
                    {
                        return Response::Error(ErrorResponse { error });
                    }
                }
            }
            return Response::SendKeys(SendKeysResponse {
                key_count: tokens.len(),
            });
        }

        if request.forward_mouse_event {
            match self.exit_clock_mode(&target).await {
                Ok(true) => {
                    return Response::SendKeys(SendKeysResponse { key_count: 0 });
                }
                Ok(false) => {}
                Err(error) => return Response::Error(ErrorResponse { error }),
            }
            let attach_pid = match target_attach_pid {
                Some(attach_pid) => attach_pid,
                None => match self
                    .resolve_attached_client_pid(requester_pid, "send-keys")
                    .await
                {
                    Ok(attach_pid) => attach_pid,
                    Err(error) => return Response::Error(ErrorResponse { error }),
                },
            };
            let mouse_event = {
                let active_attach = self.active_attach.lock().await;
                active_attach
                    .by_pid
                    .get(&attach_pid)
                    .and_then(|active| active.mouse.current_event.clone())
            };
            let Some(mouse_event) = mouse_event else {
                return Response::SendKeys(SendKeysResponse { key_count: 0 });
            };
            let mut state = self.state.lock().await;
            let bytes = match encode_mouse_for_target(&state, &target, &mouse_event) {
                Ok(bytes) => bytes,
                Err(error) => return Response::Error(ErrorResponse { error }),
            };
            let write = match prepare_pane_input_write(&mut state, &target, &bytes) {
                Ok(write) => write,
                Err(error) => return Response::Error(ErrorResponse { error }),
            };
            drop(state);
            return self
                .write_pane_input_and_mark_interactive(vec![write], bytes, 0)
                .await;
        }

        let tokens =
            if !tokens.is_empty() && !request.hex && !request.literal && !request.reset_terminal {
                match self
                    .consume_copy_mode_key_tokens(
                        target_attach_pid.unwrap_or(requester_pid),
                        &target,
                        &tokens,
                    )
                    .await
                {
                    Ok(tokens) => tokens,
                    Err(error) => return Response::Error(ErrorResponse { error }),
                }
            } else {
                tokens
            };
        if !request.keys.is_empty() && tokens.is_empty() {
            return Response::SendKeys(SendKeysResponse {
                key_count: request.keys.len(),
            });
        }
        if request.keys.is_empty() && !request.reset_terminal {
            return Response::SendKeys(SendKeysResponse { key_count: 0 });
        }

        let prepared = {
            let mut state = self.state.lock().await;
            if request.reset_terminal {
                if let Err(error) = state.reset_pane_terminal_state(&target) {
                    return Response::Error(ErrorResponse { error });
                }
            }
            let mut bytes = Vec::new();
            if request.hex {
                for token in &tokens {
                    let Some(byte) = resolve_hex_key(token) else {
                        return Response::Error(ErrorResponse {
                            error: RmuxError::Server(format!("invalid hex byte: {token}")),
                        });
                    };
                    bytes.push(byte);
                }
            } else if request.literal {
                for token in &tokens {
                    bytes.extend_from_slice(token.as_bytes());
                }
            } else {
                match encode_tokens_for_target(&state, &target, &tokens) {
                    Ok(encoded) => bytes.extend_from_slice(&encoded),
                    Err(error) => return Response::Error(ErrorResponse { error }),
                }
            }
            let repeat_count = bounded_repeat_count(request.repeat_count);
            let repeated = bytes.repeat(repeat_count);
            let writes =
                match prepare_synchronized_pane_input_writes(&mut state, &target, &repeated) {
                    Ok(writes) => writes,
                    Err(error) => return Response::Error(ErrorResponse { error }),
                };
            (writes, repeated)
        };
        self.write_pane_input_and_mark_interactive(prepared.0, prepared.1, request.keys.len())
            .await
    }

    async fn consume_copy_mode_key_tokens(
        &self,
        requester_pid: u32,
        target: &PaneTarget,
        tokens: &[String],
    ) -> Result<Vec<String>, RmuxError> {
        let mut remaining = Vec::new();
        for (index, token) in tokens.iter().enumerate() {
            if !self.target_is_in_copy_mode(target).await? {
                remaining.extend(tokens[index..].iter().cloned());
                break;
            }
            let Some(key) = parse_key_code(token) else {
                remaining.extend(tokens[index..].iter().cloned());
                break;
            };
            let handled = self
                .handle_detached_copy_mode_key_code(requester_pid, target.clone(), key)
                .await?;
            if !handled {
                remaining.extend(tokens[index..].iter().cloned());
                break;
            }
        }
        Ok(remaining)
    }

    pub(in crate::handler) async fn handle_send_prefix(
        &self,
        requester_pid: u32,
        request: rmux_proto::SendPrefixRequest,
    ) -> Response {
        let attached_session = {
            let active_attach = self.active_attach.lock().await;
            active_attach.current_session_candidate(requester_pid)
        };
        let target = {
            let state = self.state.lock().await;
            match resolve_input_target(&state, request.target.as_ref(), attached_session.as_ref()) {
                Ok(target) => target,
                Err(error) => return Response::Error(ErrorResponse { error }),
            }
        };

        let (writes, encoded, canonical_key) = {
            let mut state = self.state.lock().await;
            let option = if request.secondary {
                OptionName::Prefix2
            } else {
                OptionName::Prefix
            };
            let Some(value) = state.options.resolve(Some(target.session_name()), option) else {
                return Response::Error(ErrorResponse {
                    error: RmuxError::Server("prefix key is not configured".to_owned()),
                });
            };
            let Some(key) = key_string_lookup_string(value) else {
                return Response::Error(ErrorResponse {
                    error: RmuxError::Server(format!("unknown key: {value}")),
                });
            };
            let canonical_key = key_string_lookup_key(key_code_lookup_bits(key), false);
            let encoded = match encode_key_for_target(&state, &target, key) {
                Ok(Some(encoded)) => encoded,
                Ok(None) => {
                    return Response::Error(ErrorResponse {
                        error: RmuxError::Server(format!(
                            "key {} cannot be sent to a pane",
                            canonical_key
                        )),
                    });
                }
                Err(error) => return Response::Error(ErrorResponse { error }),
            };
            let writes = match prepare_synchronized_pane_input_writes(&mut state, &target, &encoded)
            {
                Ok(writes) => writes,
                Err(error) => return Response::Error(ErrorResponse { error }),
            };
            (writes, encoded, canonical_key)
        };

        match self
            .write_pane_input_and_mark_interactive(writes, encoded, 1)
            .await
        {
            Response::SendKeys(_) => Response::SendPrefix(SendPrefixResponse {
                target: Some(target),
                key: canonical_key,
                key_count: 1,
            }),
            other => other,
        }
    }

    async fn write_pane_input_and_mark_interactive(
        &self,
        writes: Vec<PaneInputWrite>,
        bytes: Vec<u8>,
        key_count: usize,
    ) -> Response {
        let wrote_bytes = !bytes.is_empty();
        let sessions = input_write_sessions(&writes);
        let response = write_bytes_to_targets(writes, bytes, key_count).await;
        if wrote_bytes && matches!(response, Response::SendKeys(_)) {
            for session_name in sessions {
                self.mark_attached_session_interactive_input(&session_name)
                    .await;
            }
        }
        response
    }
}

fn input_write_sessions(writes: &[PaneInputWrite]) -> Vec<rmux_proto::SessionName> {
    let mut sessions = Vec::new();
    for write in writes {
        let session_name = write.session_name();
        if !sessions.iter().any(|existing| existing == session_name) {
            sessions.push(session_name.clone());
        }
    }
    sessions
}