badterm 0.4.1

A cross-platform ANSI-BBS telnet client
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

//! The SSH login dialog: asks for a password, a key passphrase, or a
//! keyboard-interactive question while connecting.

use badterm_core::screen::Screen;
use badterm_core::session::{AuthPrompt, PromptKind};

use super::*;

const W: usize = 64;

pub struct LoginPrompt {
    pub title: String,
    pub instructions: String,
    pub question: String,
    /// Whether the answer is shown as typed.
    pub echo: bool,
    pub field: TextField,
    /// Whether "remember" is offered: passwords for directory entries only.
    pub can_remember: bool,
    pub remember: bool,
    /// Where a remembered password goes, for the label.
    pub keychain: bool,
    /// A RIPscrip text variable's question, not a login.
    pub rip: bool,
}

pub enum LoginAction {
    None,
    Answer(String),
    Cancel,
}

impl LoginPrompt {
    pub fn new(prompt: &AuthPrompt, in_directory: bool, keychain: bool) -> LoginPrompt {
        LoginPrompt {
            title: prompt.title.clone(),
            instructions: prompt.instructions.clone(),
            question: prompt.prompt.clone(),
            echo: prompt.echo,
            field: TextField::new("", 500),
            can_remember: in_directory && prompt.kind == PromptKind::Password,
            remember: false,
            keychain,
            rip: false,
        }
    }

    /// RIPscrip asking for a text variable (see [`badterm_core::rip::Question`]).
    pub fn rip_question(q: &badterm_core::rip::Question, bbs: &str) -> LoginPrompt {
        LoginPrompt {
            title: format!("{bbs} asks"),
            instructions: format!("For the RIPscrip variable {}", q.name),
            question: q.prompt.clone(),
            echo: true,
            field: TextField::new(&q.value, q.width),
            can_remember: false,
            remember: false,
            keychain: false,
            rip: true,
        }
    }

    pub fn handle_key(&mut self, key: Key, mods: Mods) -> LoginAction {
        match key {
            Key::Enter => return LoginAction::Answer(std::mem::take(&mut self.field.value)),
            Key::Escape => return LoginAction::Cancel,
            Key::Tab if self.can_remember => self.remember = !self.remember,
            _ => {
                self.field.handle_key(key, mods);
            }
        }
        LoginAction::None
    }

    /// Draw the dialog; returns the text cursor position.
    pub fn draw(&self, s: &mut Screen) -> (usize, usize) {
        let info: Vec<String> =
            self.instructions.lines().filter(|l| !l.trim().is_empty()).flat_map(|l| wrap(l, W - 6)).take(4).collect();
        let h = 7 + info.len() + usize::from(self.can_remember);
        let (x, y) = ((s.cols() - W) / 2, (s.rows().saturating_sub(h)) / 2);
        let t = theme::current();
        frame(s, x, y, W, h, &truncate(&self.title, W - 8), t.window.fg(), t.window.bg());
        let mut row = y + 2;
        for line in &info {
            label(s, x + 3, row, line, t.field_value.fg(), t.field_value.bg());
            row += 1;
        }
        text(s, x + 3, row, W - 6, &truncate(&self.question, W - 6), t.window.fg(), t.window.bg());
        let cursor = self.field.draw(s, x + 3, row + 1, W - 6, !self.echo, t.input.fg(), t.input.bg());
        row += 3;
        if self.can_remember {
            let mark = if self.remember { 'x' } else { ' ' };
            let place = if self.keychain { "in the keychain" } else { "in the directory file" };
            label(
                s,
                x + 3,
                row,
                &format!("[{mark}] Remember password {place}   Tab"),
                t.window_text.fg(),
                t.window_text.bg(),
            );
            row += 1;
        }
        label(s, x + 3, row, "Enter log in   Esc cancel", t.keys.fg(), t.keys.bg());
        cursor
    }
}

#[cfg(test)]
pub mod tests {
    use super::*;

    pub fn sample(can_remember: bool) -> LoginPrompt {
        LoginPrompt {
            title: "SSH login to bbs.example.com".into(),
            instructions: String::new(),
            question: "Password for guest:".into(),
            echo: false,
            field: TextField::new("", 500),
            can_remember,
            remember: false,
            keychain: true,
            rip: false,
        }
    }

    #[test]
    fn keys() {
        let m = Mods::default();
        let mut p = sample(true);
        for c in "pw".chars() {
            p.handle_key(Key::Char(c), m);
        }
        p.handle_key(Key::Tab, m);
        assert!(p.remember);
        assert!(matches!(p.handle_key(Key::Enter, m), LoginAction::Answer(a) if a == "pw"));
        assert!(matches!(p.handle_key(Key::Escape, m), LoginAction::Cancel));

        // Tab does nothing when remembering is not offered.
        let mut p = sample(false);
        p.handle_key(Key::Tab, m);
        assert!(!p.remember);
    }
}