ping-rust 0.3.2

Menu-driven installer and manager for the shoes proxy server
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
//! 菜单共享的纯文本输入。取消与 EOF 分开,调用方只吞掉当前操作的取消。
use std::{
    fmt::Display,
    io::{self, BufRead, Write},
    str::FromStr,
};

use anyhow::{bail, Context, Result};
use console::Term;

#[derive(Debug)]
pub(crate) struct MenuEof;
impl Display for MenuEof {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("输入已结束")
    }
}
impl std::error::Error for MenuEof {}

#[derive(Debug)]
struct MenuBack;
impl Display for MenuBack {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("已返回")
    }
}
impl std::error::Error for MenuBack {}

// Navigation state only controls the result-page pause; it never changes a
// validation, transaction, or service decision. The interactive root future
// stays on the main thread while background work uses Tokio workers.
thread_local! {
    static RETURNED: std::cell::Cell<bool> = const { std::cell::Cell::new(false) };
}

pub(crate) fn reset_navigation() {
    RETURNED.with(|value| value.set(false));
}

pub(crate) fn returned_to_parent() -> bool {
    RETURNED.with(std::cell::Cell::get)
}

pub(crate) fn back() -> anyhow::Error {
    RETURNED.with(|value| value.set(true));
    MenuBack.into()
}

pub(crate) fn clear_screen() -> Result<()> {
    let term = Term::stdout();
    if term.is_term() {
        term.clear_screen().context("清理终端失败")?;
    }
    Ok(())
}

pub(crate) fn pause_main_menu() -> Result<()> {
    read_pause(&mut io::stdin().lock(), &mut io::stdout())
}

/// 首次默认部署结束后、主菜单首次清屏前等待回车,让用户看清部署结果或失败原因。
pub(crate) fn pause_enter_main_menu() -> Result<()> {
    read_pause_with(
        &mut io::stdin().lock(),
        &mut io::stdout(),
        "按回车进入主菜单...",
    )
}

fn read_pause(reader: &mut impl BufRead, writer: &mut impl Write) -> Result<()> {
    read_pause_with(reader, writer, "按回车返回主菜单...")
}

fn read_pause_with(reader: &mut impl BufRead, writer: &mut impl Write, text: &str) -> Result<()> {
    write!(writer, "\n{text}")?;
    writer.flush()?;
    loop {
        match line(reader) {
            Ok(value) if value.trim().is_empty() => return Ok(()),
            Ok(_) => continue,
            Err(error) => return Err(error),
        }
    }
}

pub(crate) fn is_back(error: &anyhow::Error) -> bool {
    error.is::<MenuBack>()
}

fn line(reader: &mut impl BufRead) -> Result<String> {
    let mut value = String::new();
    if reader.read_line(&mut value).context("读取输入失败")? == 0 {
        return Err(MenuEof.into());
    }
    Ok(value.trim_end_matches(['\r', '\n']).to_owned())
}

fn text_prompt(writer: &mut impl Write, prompt: &str, default: Option<&str>) -> Result<()> {
    match default {
        Some(value) => write!(writer, "{prompt}(默认:{value},输入 0 返回):")?,
        None => write!(writer, "{prompt}(输入 0 返回):")?,
    }
    writer.flush().context("输出输入提示失败")
}

fn parse_text<T>(
    value: &str,
    default: Option<&str>,
    allow_empty: bool,
    parse: &impl Fn(&str) -> Result<T>,
) -> Result<T> {
    if value.trim() == "0" {
        return Err(back());
    }
    let value = if value.is_empty() {
        default.unwrap_or(value)
    } else {
        value
    };
    if !allow_empty && value.trim().is_empty() {
        bail!("请输入内容");
    }
    if value.trim() == "0" {
        bail!("0 用于返回,请输入其他内容");
    }
    parse(value)
}

pub(crate) fn read_text<T>(
    reader: &mut impl BufRead,
    writer: &mut impl Write,
    prompt: &str,
    default: Option<&str>,
    allow_empty: bool,
    parse: impl Fn(&str) -> Result<T>,
) -> Result<T> {
    loop {
        text_prompt(writer, prompt, default)?;
        let value = line(reader)?;
        match parse_text(&value, default, allow_empty, &parse) {
            Ok(value) => {
                reset_navigation();
                return Ok(value);
            }
            Err(error) if is_back(&error) => return Err(error),
            Err(error) => writeln!(writer, "错误!{error:#}")?,
        }
    }
}

pub(crate) fn read_confirm(
    reader: &mut impl BufRead,
    writer: &mut impl Write,
    prompt: &str,
    default: bool,
) -> Result<bool> {
    loop {
        write!(
            writer,
            "{prompt} [{}](输入 0 返回):",
            if default { "Y/n" } else { "y/N" }
        )?;
        writer.flush()?;
        match line(reader)?.trim().to_ascii_lowercase().as_str() {
            "y" | "yes" => {
                reset_navigation();
                return Ok(true);
            }
            "n" | "no" => {
                reset_navigation();
                return Ok(false);
            }
            "" => {
                reset_navigation();
                return Ok(default);
            }
            "0" => return Err(back()),
            _ => writeln!(writer, "错误!请输入 y、yes、n、no 或 0")?,
        }
    }
}

/// 仅用于 0 本身有意义的数字参数,回车保留当前值。
pub(crate) fn read_number<T>(
    reader: &mut impl BufRead,
    writer: &mut impl Write,
    prompt: &str,
    current: T,
) -> Result<T>
where
    T: FromStr + Display + Copy,
    T::Err: Display,
{
    loop {
        write!(writer, "{prompt}(默认:{current},0 为合法值):")?;
        writer.flush()?;
        let value = line(reader)?;
        if value.trim().is_empty() {
            return Ok(current);
        }
        match value.trim().parse() {
            Ok(value) => return Ok(value),
            Err(error) => writeln!(writer, "错误!请输入有效数字:{error}")?,
        }
    }
}

pub(crate) fn read_menu_choice(
    reader: &mut impl BufRead,
    writer: &mut impl Write,
    max: usize,
) -> Result<String> {
    loop {
        write!(writer, "请选择 [0-{max}]: ")?;
        writer.flush().context("输出菜单提示失败")?;
        let value = line(reader)?;
        if value.trim().is_empty() {
            continue;
        }
        if let Ok(selected) = value.trim().parse::<usize>() {
            if selected <= max {
                RETURNED.with(|returned| returned.set(selected == 0));
                return Ok(value);
            }
        }
        writeln!(writer, "无效序号!")?;
    }
}

pub(crate) fn text(
    prompt: impl AsRef<str>,
    default: Option<&str>,
    allow_empty: bool,
) -> Result<String> {
    validated_text(prompt, default, allow_empty, |v| Ok(v.to_owned()))
}

pub(crate) fn validated_text<T>(
    prompt: impl AsRef<str>,
    default: Option<&str>,
    allow_empty: bool,
    parse: impl Fn(&str) -> Result<T>,
) -> Result<T> {
    read_text(
        &mut io::stdin().lock(),
        &mut io::stdout(),
        prompt.as_ref(),
        default,
        allow_empty,
        parse,
    )
}

pub(crate) fn checked_text(
    prompt: impl AsRef<str>,
    default: Option<&str>,
    allow_empty: bool,
    validate: impl Fn(&str) -> Result<()>,
) -> Result<String> {
    validated_text(prompt, default, allow_empty, |value| {
        if !value.is_empty() {
            validate(value)?;
        }
        Ok(value.to_owned())
    })
}

pub(crate) fn file_path(prompt: &str) -> Result<String> {
    checked_text(prompt, None, false, |value| {
        std::fs::File::open(value)
            .and_then(|file| {
                if file.metadata()?.is_file() {
                    Ok(())
                } else {
                    Err(io::Error::other("路径不是文件"))
                }
            })
            .context("无法读取文件,请检查路径及权限")
    })
}

pub(crate) fn confirm(prompt: impl AsRef<str>, default: bool) -> Result<bool> {
    read_confirm(
        &mut io::stdin().lock(),
        &mut io::stdout(),
        prompt.as_ref(),
        default,
    )
}

pub(crate) fn number<T>(prompt: impl AsRef<str>, current: T) -> Result<T>
where
    T: FromStr + Display + Copy,
    T::Err: Display,
{
    read_number(
        &mut io::stdin().lock(),
        &mut io::stdout(),
        prompt.as_ref(),
        current,
    )
}

pub(crate) fn port(prompt: impl AsRef<str>, default: Option<u16>) -> Result<u16> {
    let default = default.map(|v| v.to_string());
    validated_text(prompt, default.as_deref(), false, |v| {
        v.trim()
            .parse::<u16>()
            .ok()
            .filter(|port| *port > 0)
            .context("请输入 1 到 65535 的端口")
    })
}

/// 注入的 reader 在终端环境由 SecureReader 提供不回显的整行输入。
pub(crate) fn read_password(
    reader: &mut impl BufRead,
    writer: &mut impl Write,
    prompt: &str,
    allow_empty: bool,
) -> Result<String> {
    read_text(reader, writer, prompt, None, allow_empty, |value| {
        Ok(value.to_owned())
    })
}

struct SecureReader {
    term: Term,
    line: io::Cursor<Vec<u8>>,
}

impl io::Read for SecureReader {
    fn read(&mut self, buffer: &mut [u8]) -> io::Result<usize> {
        let available = self.fill_buf()?;
        let count = available.len().min(buffer.len());
        buffer[..count].copy_from_slice(&available[..count]);
        self.consume(count);
        Ok(count)
    }
}

impl BufRead for SecureReader {
    fn fill_buf(&mut self) -> io::Result<&[u8]> {
        if self.line.position() as usize == self.line.get_ref().len() {
            if !self.term.is_term() {
                return Err(io::ErrorKind::UnexpectedEof.into());
            }
            let mut value = self.term.read_secure_line()?;
            value.push('\n');
            self.line = io::Cursor::new(value.into_bytes());
        }
        self.line.fill_buf()
    }

    fn consume(&mut self, amount: usize) {
        self.line.consume(amount);
    }
}

pub(crate) fn password(prompt: impl AsRef<str>, allow_empty: bool) -> Result<String> {
    let mut reader = SecureReader {
        term: Term::stderr(),
        line: io::Cursor::new(Vec::new()),
    };
    read_password(&mut reader, &mut io::stdout(), prompt.as_ref(), allow_empty).map_err(|error| {
        if error
            .downcast_ref::<io::Error>()
            .is_some_and(|e| e.kind() == io::ErrorKind::UnexpectedEof)
        {
            MenuEof.into()
        } else {
            error
        }
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Cursor;

    fn text(input: &str, default: Option<&str>) -> (Result<String>, String) {
        let mut output = Vec::new();
        let result = read_text(
            &mut Cursor::new(input),
            &mut output,
            "名称",
            default,
            false,
            |value| {
                if value.contains('/') {
                    anyhow::bail!("名称不能包含斜杠");
                }
                Ok(value.to_owned())
            },
        );
        (result, String::from_utf8(output).unwrap())
    }

    #[test]
    fn numeric_menu_ignores_empty_and_unifies_invalid_choices() {
        let mut output = Vec::new();
        assert_eq!(
            read_menu_choice(&mut Cursor::new("\n  \n-1\ntext\n11\n2\n"), &mut output, 10).unwrap(),
            "2"
        );
        let output = String::from_utf8(output).unwrap();
        assert_eq!(output.matches("无效序号!").count(), 3);
        assert_eq!(output.matches("请选择 [0-10]: ").count(), 6);
        assert!(!output.contains("可选"));
        assert!(!returned_to_parent());
        for zero in ["0\n", "00\n", "+0\n"] {
            read_menu_choice(&mut Cursor::new(zero), &mut Vec::new(), 10).unwrap();
            assert!(returned_to_parent());
        }
        reset_navigation();
        assert!(!returned_to_parent());
    }

    #[test]
    fn result_page_waits_for_enter_without_repeating_output() {
        let mut output = Vec::new();
        read_pause(&mut Cursor::new("1\n0\n\n"), &mut output).unwrap();
        assert_eq!(String::from_utf8(output).unwrap(), "\n按回车返回主菜单...");
    }

    #[test]
    fn result_page_preserves_eof_instead_of_returning_to_main_menu() {
        for input in ["", "1\n0\n"] {
            let mut output = Vec::new();
            assert!(read_pause(&mut Cursor::new(input), &mut output)
                .unwrap_err()
                .is::<MenuEof>());
            assert_eq!(String::from_utf8(output).unwrap(), "\n按回车返回主菜单...");
        }
    }

    #[test]
    fn text_default_required_back_invalid_and_eof() {
        assert_eq!(text("\n", Some("当前名称")).0.unwrap(), "当前名称");
        let (result, output) = text("\n新名称\n", None);
        assert_eq!(result.unwrap(), "新名称");
        assert_eq!(output.matches("名称(输入 0 返回):").count(), 2);
        assert!(output.contains("错误!请输入内容"));
        assert!(is_back(&text("0\n", Some("原名称")).0.unwrap_err()));
        let (result, output) = text("bad/name\n正确名称\n", None);
        assert_eq!(result.unwrap(), "正确名称");
        assert!(output.contains("错误!名称不能包含斜杠"));
        assert!(text("", None).0.unwrap_err().is::<MenuEof>());
    }

    #[test]
    fn zero_default_cannot_create_a_name_and_numbered_eof_is_typed() {
        let (result, output) = text("\n新名称\n", Some("0"));
        assert_eq!(result.unwrap(), "新名称");
        assert!(output.contains("错误!0 用于返回,请输入其他内容"));
        let mut output = Vec::new();
        assert_eq!(
            read_menu_choice(&mut Cursor::new("2\n"), &mut output, 10).unwrap(),
            "2"
        );
        assert_eq!(String::from_utf8(output).unwrap(), "请选择 [0-10]: ");
        assert!(read_menu_choice(&mut Cursor::new(""), &mut Vec::new(), 10)
            .unwrap_err()
            .is::<MenuEof>());
    }

    #[test]
    fn plain_text_input_transcripts() {
        let mut output = Vec::new();
        assert_eq!(
            read_menu_choice(&mut Cursor::new("2\n"), &mut output, 10).unwrap(),
            "2"
        );
        writeln!(output, "[注入输入:2]").unwrap();
        assert!(is_back(
            &read_text(
                &mut Cursor::new("0\n"),
                &mut output,
                "新配置名称",
                Some("example-node"),
                false,
                |v| Ok(v.to_owned())
            )
            .unwrap_err()
        ));
        writeln!(output, "[注入输入:0;返回上一级]").unwrap();
        println!(
            "记录一(输入模块,注入 I/O):\n{}",
            String::from_utf8(output).unwrap()
        );

        let mut output = Vec::new();
        assert!(!read_confirm(
            &mut Cursor::new("\n"),
            &mut output,
            "确认删除 example-node?",
            false
        )
        .unwrap());
        writeln!(output, "[注入输入:回车;确认结果:否]").unwrap();
        println!(
            "记录二(输入模块,注入 I/O):\n{}",
            String::from_utf8(output).unwrap()
        );

        let mut output = Vec::new();
        let port = read_text(
            &mut Cursor::new("65536\n443\n"),
            &mut output,
            "新端口",
            Some("443"),
            false,
            |v| v.parse::<u16>().context("请输入 1 到 65535 的端口"),
        )
        .unwrap();
        assert_eq!(port, 443);
        writeln!(output, "[依次注入:65536、443;读取结果:443]").unwrap();
        println!(
            "记录三(输入模块,注入 I/O):\n{}",
            String::from_utf8(output).unwrap()
        );
    }

    #[test]
    fn confirm_yes_no_default_back_and_retry() {
        for (value, expected) in [
            ("y\n", true),
            ("yes\n", true),
            ("n\n", false),
            ("no\n", false),
            ("\n", false),
        ] {
            let mut output = Vec::new();
            assert_eq!(
                read_confirm(&mut Cursor::new(value), &mut output, "确认删除?", false).unwrap(),
                expected
            );
            assert_eq!(
                String::from_utf8(output).unwrap(),
                "确认删除? [y/N](输入 0 返回):"
            );
        }
        assert!(read_confirm(&mut Cursor::new("\n"), &mut Vec::new(), "启用?", true).unwrap());
        assert!(is_back(
            &read_confirm(&mut Cursor::new("0\n"), &mut Vec::new(), "删除?", false).unwrap_err()
        ));
        let mut output = Vec::new();
        assert!(read_confirm(
            &mut Cursor::new("maybe\nyes\n"),
            &mut output,
            "继续?",
            false
        )
        .unwrap());
        assert!(String::from_utf8(output)
            .unwrap()
            .contains("错误!请输入 y、yes、n、no 或 0"));
        assert!(
            read_confirm(&mut Cursor::new(""), &mut Vec::new(), "继续?", false)
                .unwrap_err()
                .is::<MenuEof>()
        );
    }

    #[test]
    fn zero_is_a_number_and_enter_keeps_current_value() {
        for (value, expected) in [("0\n", 0), ("\n", 4), ("bad\n0\n", 0)] {
            let mut output = Vec::new();
            assert_eq!(
                read_number(
                    &mut Cursor::new(value),
                    &mut output,
                    "Max connections",
                    4u32
                )
                .unwrap(),
                expected
            );
            let output = String::from_utf8(output).unwrap();
            assert!(output.contains("Max connections(默认:4,0 为合法值):"));
            assert!(!output.contains("输入 0 返回"));
        }
    }

    #[test]
    fn password_rules_use_same_parser_without_writing_secret() {
        let mut output = Vec::new();
        assert_eq!(
            read_password(
                &mut Cursor::new("\n"),
                &mut output,
                "密码(留空安全随机生成)",
                true
            )
            .unwrap(),
            ""
        );
        assert!(is_back(
            &read_password(&mut Cursor::new("0\n"), &mut output, "密码", true).unwrap_err()
        ));
        assert!(
            read_password(&mut Cursor::new(""), &mut output, "密码", true)
                .unwrap_err()
                .is::<MenuEof>()
        );
        let secret = "fixture-only-password";
        assert_eq!(
            read_password(
                &mut Cursor::new(format!("{secret}\n")),
                &mut output,
                "密码",
                true
            )
            .unwrap(),
            secret
        );
        assert!(!String::from_utf8(output).unwrap().contains(secret));
    }
}