badterm 0.4.4

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
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
//! The keyboard: BadTerm's hotkeys, and keys for whichever screen or
//! dialog is in front.

use super::call::Slot;
use super::*;
use crate::hotkeys::label as hk;

/// The font files in the fonts folder, by name, in order.
fn font_files(dir: &std::path::Path) -> Vec<String> {
    let Ok(read) = std::fs::read_dir(dir) else { return Vec::new() };
    let mut names: Vec<String> = read
        .flatten()
        .filter_map(|e| e.file_name().into_string().ok())
        .filter(|n| {
            let ext = n.rsplit_once('.').map(|(_, e)| e.to_ascii_lowercase()).unwrap_or_default();
            badterm_core::fontfile::EXTENSIONS.contains(&ext.as_str())
        })
        .collect();
    names.sort_by_key(|n| n.to_lowercase());
    names
}

impl App {
    pub(super) fn on_key(&mut self, event_loop: &ActiveEventLoop, event: &KeyEvent) {
        // Any key closes the splash screen (and does nothing else).
        if self.splash_until.take().is_some() {
            return self.request_redraw();
        }
        let mods = Mods::from(self.mods);
        if mods.hotkey()
            && let PhysicalKey::Code(code) = event.physical_key
            && self.hotkey(event_loop, code)
        {
            return self.request_redraw();
        }
        let Some(key) = input::translate(event) else { return };
        self.selection = None;
        if self.confirm_exit {
            match key {
                Key::Char('y') | Key::Char('Y') | Key::Enter => event_loop.exit(),
                Key::Char('n') | Key::Char('N') | Key::Escape => self.confirm_exit = false,
                _ => {}
            }
            return self.request_redraw();
        }
        if self.help_open {
            self.help_open = false;
        } else if self.settings_open {
            self.settings_key(key, mods);
        } else if self.art_picker.is_some() {
            self.art_picker_key(key, mods);
        } else if let Some(v) = self.art.as_mut() {
            match v.handle_key(key) {
                ArtAction::None => {}
                ArtAction::Close => self.art = None,
                ArtAction::Open => self.open_art_picker(),
            }
        } else if self.dialer_open {
            self.dialer_key(key, mods);
        } else if let Some(tab) = self.tab() {
            // The call on screen, or the question it is asking.
            if tab.login.is_some() {
                self.login_key(key, mods);
            } else if tab.save_prompt.is_some() {
                self.save_key(key, mods);
            } else if tab.upload_prompt.is_some() {
                self.prompt_key(key, mods);
            } else if tab.download_prompt.is_some() {
                self.download_key(key, mods);
            } else if tab.session.transfer().is_some() {
                if key == Key::Escape
                    && let Some(tab) = self.tab_mut()
                {
                    tab.session.cancel_transfer();
                    self.session_events(self.active);
                }
            } else {
                self.terminal_key(key, mods);
            }
        }
        // With no call and the dialer closed (the idle screen), only the
        // hotkeys do anything.
        self.request_redraw();
    }

    pub(super) fn dialer_key(&mut self, key: Key, mods: Mods) {
        let mut template = Entry::default();
        self.new_entry_defaults(&mut template);
        self.dialer.new_entry = template;
        self.dialer.global_macros = self.settings.macros.clone();
        self.dialer.font_files = font_files(&self.paths.fonts);
        match self.dialer.handle_key(key, mods, &mut self.directory) {
            Action::None => {}
            Action::Connect(i) => {
                let e = self.directory.entries[i].clone();
                self.dial(e, Some(i));
            }
            Action::QuickConnect(e) => self.dial(*e, None),
            Action::Changed => self.save_directory(),
            Action::HangUpAndDial => {
                if let Some((e, i)) = self.pending_dial.take() {
                    self.open_call(e, i, Slot::Replace(self.active));
                }
            }
            Action::NewTab => {
                if let Some((e, i)) = self.pending_dial.take() {
                    self.open_call(e, i, Slot::New);
                }
            }
            Action::Settings => self.open_settings(),
            Action::Close => {
                self.dialer_open = false;
                self.pending_dial = None;
                self.new_tab_dial = false;
            }
        }
    }

    /// Client hotkeys (Alt, or Cmd on macOS). Returns true if handled.
    pub(super) fn hotkey(&mut self, event_loop: &ActiveEventLoop, code: KeyCode) -> bool {
        // Keys the user moved act as the ones they usually are; a letter
        // no action is on goes to the BBS.
        let Some(code) = crate::hotkeys::translate(code) else { return false };
        // While "Exit BadTerm?" shows, only Alt-X (yes) does anything.
        if self.confirm_exit && code != KeyCode::KeyX {
            return true;
        }
        match code {
            KeyCode::Enter | KeyCode::NumpadEnter => {
                if let Some(g) = &self.gfx {
                    let fs = g.window.fullscreen().is_none().then_some(Fullscreen::Borderless(None));
                    g.window.set_fullscreen(fs);
                }
                return true;
            }
            // Asks first; Alt-X again (or Y) is yes.
            KeyCode::KeyX => {
                if self.confirm_exit {
                    event_loop.exit();
                }
                self.confirm_exit = true;
                return true;
            }
            // The stored login: the user name, then the password.
            KeyCode::KeyL => {
                let msg = match self.tab_mut().map(|t| &mut t.session).filter(|s| s.state == State::Connected) {
                    None => Some("Not connected"),
                    Some(s) if !s.has_login() => Some("This entry has no user name or password"),
                    // The session reports what it sent.
                    Some(s) => (!s.send_login()).then_some("The user name and password were sent"),
                };
                if let Some(m) = msg {
                    self.notify(m);
                }
                self.session_events(self.active);
                return true;
            }
            // Display settings, from anywhere.
            KeyCode::KeyP => {
                // A system with its own phosphor mode keeps the change.
                if let Some(mode) = self.own_crt_mode() {
                    let next = mode.next();
                    if let Some(t) = self.tab_mut() {
                        t.session.entry.crt = Some(next);
                    }
                    if let Some(e) = self.entry_mut(self.active) {
                        e.crt = Some(next);
                        self.save_directory();
                    }
                    let name = self.session().map_or("", |s| s.entry.name.as_str());
                    self.notify(format!("Phosphor mode for {name}: {}", next.name()));
                } else {
                    self.settings.crt = self.settings.crt.next();
                    let msg = format!("Phosphor mode: {}", self.settings.crt.name());
                    self.settings_changed(msg);
                }
                return true;
            }
            KeyCode::KeyA => {
                self.settings.aspect = self.settings.aspect.next();
                let msg = format!("Shape: {}", self.settings.aspect.name());
                self.settings_changed(msg);
                return true;
            }
            KeyCode::KeyM => {
                self.settings.music = self.settings.music.next();
                if self.settings.music == Music::Off {
                    self.player.stop();
                }
                for t in &mut self.tabs {
                    t.session.term.music_on_csi_m = self.settings.music == Music::All;
                    t.session.term.music_enabled = self.settings.music != Music::Off;
                }
                let msg = self.settings.music.name();
                self.settings_changed(msg);
                return true;
            }
            KeyCode::KeyW => {
                self.settings.nine_dot = !self.settings.nine_dot;
                let msg = if self.settings.nine_dot { "9-dot characters, as on a VGA" } else { "8-dot characters" };
                self.settings_changed(msg);
                return true;
            }
            // The dialing directory, from anywhere; the session (if any)
            // stays connected behind it.
            KeyCode::KeyD => {
                self.dialer_open = !self.dialer_open;
                self.pending_dial = None;
                self.new_tab_dial = false;
                self.settings_open = false;
                self.help_open = false;
                return true;
            }
            // The dialing directory, to call a BBS in a tab of its own; the
            // calls open stay connected.
            KeyCode::KeyN => {
                if self.tabs.len() >= tabs::MAX_TABS {
                    self.notify(format!("{} calls are open, the most there can be", tabs::MAX_TABS));
                } else {
                    self.dialer_open = true;
                    self.new_tab_dial = true;
                    self.pending_dial = None;
                    self.settings_open = false;
                    self.help_open = false;
                    self.notify("Choose a BBS to call in a new tab");
                }
                return true;
            }
            // A script: choose one to run, or stop the one running.
            KeyCode::KeyJ => {
                if self.tab().is_some_and(|t| t.script.is_some()) {
                    self.stop_script(self.active, Some("stopped"));
                } else if self.art_picker.is_some() && self.picking_script {
                    self.art_picker = None;
                } else if self.session().is_some_and(|s| s.state == State::Connected) {
                    self.art = None;
                    self.open_script_picker();
                } else {
                    self.notify("Scripts run during a call");
                }
                return true;
            }
            // The ANSI viewer, from anywhere.
            KeyCode::KeyF => {
                if self.art.is_some() || self.art_picker.is_some() {
                    self.art = None;
                    self.art_picker = None;
                } else {
                    self.open_art_picker();
                }
                return true;
            }
            KeyCode::KeyO => {
                if self.settings_open {
                    self.settings_open = false;
                } else {
                    self.open_settings();
                }
                return true;
            }
            // Help, as in Telix.
            KeyCode::KeyZ => {
                self.help_open = !self.help_open;
                return true;
            }
            _ => {}
        }
        // Session hotkeys act on what is on screen, so they are swallowed
        // while the dialer (or settings, or help) covers the session.
        if self.dialer_open || self.settings_open || self.help_open || self.art.is_some() || self.art_picker.is_some() {
            return true;
        }
        if let Some(i) = macro_index(code) {
            self.start_macro(i);
            return true;
        }
        // The next call (Shift: the one before).
        if code == KeyCode::KeyT {
            match self.tabs.len() {
                0 => self.notify("Not connected"),
                1 => self.notify(format!("This is the only call: {} calls another in a new tab", hk("N"))),
                n => {
                    let t = tabs::cycle(self.active, n, self.mods.shift_key());
                    self.show_tab(t);
                    let name = self.tabs[t].session.entry.name.clone();
                    self.notify(format!("Tab {} of {n}: {name}", t + 1));
                }
            }
            return true;
        }
        let t = self.active;
        let Some(session) = self.tabs.get_mut(t).map(|tab| &mut tab.session) else { return false };
        match code {
            KeyCode::KeyH => self.hang_up(),
            // Call again: now, if a redial is waiting, or after a hang-up.
            KeyCode::KeyR if session.state == State::Closed => {
                if self.tabs[t].redial.is_none() {
                    let entry = self.tabs[t].session.entry.clone();
                    let index = self.entry_index(t);
                    self.tabs[t].redial = Some(Redial { entry, index, attempt: 0, at: Instant::now() });
                }
                self.redial_now(t);
            }
            KeyCode::KeyB => {
                let tab = &mut self.tabs[t];
                let sc = &tab.session.term.screen;
                let page = sc.rows().min(sc.scrollback_len());
                tab.scroll = tab.scroll.max(1).max(page);
            }
            // A teletext page's concealed text (Viewdata, Mode 7).
            KeyCode::KeyK => {
                match session.term.toggle_reveal() {
                    Some(true) => self.notify("Concealed text shown"),
                    Some(false) => self.notify("Concealed text hidden"),
                    None => self.notify(format!(
                        "{} reveals concealed text on Viewdata and Mode 7 pages",
                        crate::hotkeys::label("K")
                    )),
                }
                self.request_redraw();
            }
            KeyCode::KeyI => {
                let s = &mut session.term.screen;
                s.ice_colors = !s.ice_colors;
                let on = s.ice_colors;
                let mut msg = if on { "iCE colors on" } else { "iCE colors off (blinking)" }.to_string();
                // A BBS with its own setting keeps the change.
                if session.entry.ice.is_some() {
                    session.entry.ice = Some(on);
                    session.term.screen.base_ice = on;
                    if let Some(e) = self.entry_mut(t) {
                        e.ice = Some(on);
                        msg = format!("{msg} for {}", e.name);
                        self.save_directory();
                    }
                }
                self.notify(msg);
            }
            KeyCode::KeyE => {
                let t = &mut session.term;
                // Between the PC's two; a C64 or Atari system stays as it is.
                t.encoding = match t.encoding {
                    Encoding::Cp437 => Encoding::Utf8,
                    Encoding::Utf8 => Encoding::Cp437,
                    e => e,
                };
                let msg = format!("Encoding: {}", t.encoding.name());
                self.notify(msg);
            }
            KeyCode::KeyC => self.toggle_capture(t),
            KeyCode::KeyS => {
                let now = dialer::now();
                let name = format!("{}-{}.ans", file_stem(&session.entry.name), stamp(now));
                let path = self.folder(Folders::SAVES).join(name);
                let tab = &mut self.tabs[t];
                tab.upload_prompt = None;
                tab.save_prompt = Some(SavePrompt::new(&path));
            }
            KeyCode::KeyV => self.paste(),
            // During an upload, the prompt adds files to the batch.
            KeyCode::KeyU
                if session.state == State::Connected
                    && session.transfer().is_none_or(|t| t.progress().direction == Direction::Upload) =>
            {
                let requested = session.upload_requested();
                self.open_upload(t, requested);
            }
            KeyCode::KeyG if session.state == State::Connected && session.transfer().is_none() => {
                let prompt = DownloadPrompt::new(self.download_protocol);
                let tab = &mut self.tabs[t];
                tab.upload_prompt = None;
                tab.download_prompt = Some(prompt);
            }
            _ => return false,
        }
        true
    }

    pub(super) fn login_key(&mut self, key: Key, mods: Mods) {
        let t = self.active;
        let Some(tab) = self.tabs.get_mut(t) else { return };
        let Some(login) = tab.login.as_mut() else { return };
        if login.rip {
            let answer = match login.handle_key(key, mods) {
                LoginAction::None => return,
                LoginAction::Answer(a) => Some(a),
                LoginAction::Cancel => None,
            };
            tab.login = None;
            tab.session.answer_rip(answer);
            return self.session_events(t);
        }
        let answer = match login.handle_key(key, mods) {
            LoginAction::None => return,
            LoginAction::Answer(a) => {
                // A later question (say, a one-time code) leaves the
                // password's choice alone.
                if login.can_remember {
                    tab.remember = login.remember.then(|| a.clone());
                }
                Some(a)
            }
            LoginAction::Cancel => None,
        };
        tab.login = None;
        tab.session.answer_prompt(answer);
    }

    pub(super) fn terminal_key(&mut self, key: Key, mods: Mods) {
        let Some(tab) = self.tab_mut() else { return };
        // A finished call stays on screen to be read (and scrolled back)
        // until Alt-H clears it or another call is dialed.
        let (rows, max) = (tab.session.term.screen.rows(), tab.session.term.screen.scrollback_len());
        if tab.scroll > 0 {
            tab.scroll = match key {
                Key::Up => tab.scroll + 1,
                Key::Down => tab.scroll - 1,
                Key::PageUp => tab.scroll + rows,
                Key::PageDown => tab.scroll.saturating_sub(rows),
                Key::Home => max,
                _ => 0,
            }
            .min(max);
            return;
        }
        match key {
            Key::PageUp if mods.shift => tab.scroll = rows.min(max),
            Key::Escape if tab.redial.is_some() => {
                tab.redial = None;
                self.notify("Redial cancelled");
            }
            _ if tab.session.state == State::Closed => {}
            Key::Insert if mods.shift => self.paste(),
            _ => {
                let session = &mut tab.session;
                let bytes = input::encode(key, mods, session.term.encoding, session.term.codepage());
                if !bytes.is_empty() {
                    session.term.interrupt();
                    session.send(&bytes);
                }
            }
        }
    }

    pub(super) fn art_picker_key(&mut self, key: Key, mods: Mods) {
        let Some(picker) = self.art_picker.as_mut() else { return };
        if key == Key::Escape {
            self.art_picker = None;
            self.picking_script = false;
            return;
        }
        if let PickerAction::Chosen(paths) = picker.handle_key(key, mods) {
            let script = std::mem::take(&mut self.picking_script);
            if !script {
                self.art_dir = picker.dir().to_path_buf();
            }
            self.art_picker = None;
            match paths.first() {
                Some(path) if script => self.run_script(self.active, path),
                Some(path) => self.view_art(path),
                None => {}
            }
        }
    }

    pub(super) fn save_key(&mut self, key: Key, mods: Mods) {
        let Some(tab) = self.tab_mut() else { return };
        let Some(prompt) = tab.save_prompt.as_mut() else { return };
        match key {
            Key::Escape => tab.save_prompt = None,
            Key::Enter => {
                let path = prompt.path();
                tab.save_prompt = None;
                let msg = match self.save(&path) {
                    Ok(what) => format!("Saved {what} to {}", path.display()),
                    Err(e) => format!("Save failed: {e:#}"),
                };
                self.notify(msg);
            }
            _ => {
                prompt.field.handle_key(key, mods);
            }
        }
    }

    pub(super) fn prompt_key(&mut self, key: Key, mods: Mods) {
        let Some(tab) = self.tabs.get_mut(self.active) else { return };
        let Some(prompt) = tab.upload_prompt.as_mut() else { return };
        match prompt.handle_key(key, mods) {
            UploadAction::None => {}
            UploadAction::Cancel => {
                tab.upload_prompt = None;
                // A BBS waiting for the upload is told to give up.
                tab.session.decline_upload();
            }
            UploadAction::Send(protocol, paths) => {
                tab.upload_dir = prompt.picker.dir().to_path_buf();
                if !prompt.requested {
                    self.upload_protocol = prompt.protocol;
                }
                tab.upload_prompt = None;
                match protocol {
                    Proto::Zmodem => self.start_upload(paths),
                    Proto::Xy(p) => self.start_xy_upload(p, paths),
                    Proto::Kermit => self.start_kermit_upload(paths),
                }
            }
        }
    }

    pub(super) fn download_key(&mut self, key: Key, mods: Mods) {
        let Some(tab) = self.tabs.get_mut(self.active) else { return };
        let Some(prompt) = tab.download_prompt.as_mut() else { return };
        match prompt.handle_key(key, mods) {
            DownloadAction::None => {}
            DownloadAction::Cancel => tab.download_prompt = None,
            DownloadAction::Receive(protocol, name) => {
                self.download_protocol = prompt.protocol;
                tab.download_prompt = None;
                let session = &mut tab.session;
                let started = match protocol {
                    Proto::Xy(p) => session.start_xy_download(p, name),
                    Proto::Kermit | Proto::Zmodem => session.start_kermit_download(),
                };
                if let Err(e) = started {
                    self.notify(format!("Download failed: {e:#}"));
                }
                self.session_events(self.active);
            }
        }
    }

    pub(super) fn settings_key(&mut self, key: Key, mods: Mods) {
        match self.settings_ui.handle_key(key, mods, &mut self.settings) {
            settings_ui::Action::None => {}
            settings_ui::Action::Changed => self.apply_settings(),
            settings_ui::Action::Close => self.settings_open = false,
            settings_ui::Action::Import(path) => {
                let msg = match self.import_theme(&path) {
                    Ok((name, dest)) => format!(
                        "Imported \"{name}\" and switched to it. It is kept as {}, and is in the color scheme list.",
                        dest.display()
                    ),
                    Err(e) => format!("Could not import the theme: {e:#}"),
                };
                self.settings_ui.show_message(msg);
            }
            settings_ui::Action::Export(name) => {
                let file = ThemeFile { name: name.clone(), author: String::new(), colors: self.settings.colors };
                let dest = self.paths.themes.join(theme::file_name(&name));
                let msg = match file.save(&dest) {
                    Ok(()) => format!(
                        "Saved \"{name}\" as {}. Share that file: anyone can bring it in with Import a theme.",
                        dest.display()
                    ),
                    Err(e) => format!("Could not save the theme: {e:#}"),
                };
                self.settings_ui.set_themes(theme::user_themes(&self.paths.themes));
                self.settings_ui.show_message(msg);
            }
        }
    }

    /// The upload prompt, in tab `t`'s call.
    pub(super) fn open_upload(&mut self, t: usize, requested: bool) {
        let Some(tab) = self.tabs.get(t) else { return };
        let dir = match tab.upload_dir.as_os_str().is_empty() {
            // It starts in this BBS's folder.
            true => self.entry_folder(&tab.session.entry, Folders::UPLOADS),
            false => tab.upload_dir.clone(),
        };
        let prompt = UploadPrompt::new(requested, dir.clone(), self.upload_protocol);
        let tab = &mut self.tabs[t];
        tab.upload_dir = dir;
        tab.download_prompt = None;
        tab.upload_prompt = Some(prompt);
    }
}