bmux_presenter_plugin 0.0.1-alpha.3

Plugin-owned native presentation CLI and managed hosting
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
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
//! CLI syntax and policy. No terminal or host side effects during parsing.
use anyhow::{Context, Result, bail, ensure};
use bmux_presenter_runtime::protocol::InteractionMode;
use std::{net::IpAddr, path::PathBuf};

/// CLI values only: shared configuration resolution owns environment/defaults.
#[derive(Debug, Clone)]
pub(crate) struct BroadcastOptions {
    pub source: uuid::Uuid,
    /// None selects the configured default when publish is true.
    pub profile: Option<String>,
    pub publish: bool,
}

#[derive(Default, Debug)]
pub(crate) struct WebOptions {
    pub enabled: bool,
    pub broadcast: Option<BroadcastOptions>,
    pub assets: Option<PathBuf>,
    pub only: bool,
    pub port: Option<u16>,
    pub auth: Option<String>,
    pub host: Option<IpAddr>,
    pub public_host: Option<IpAddr>,
    pub allowed_hosts: Option<Vec<String>>,
}

impl WebOptions {
    fn parse(args: &mut Arguments<'_>) -> Result<Self> {
        let profile = args.value("--broadcast-profile")?;
        ensure!(
            profile.as_ref().is_none_or(|name| !name.trim().is_empty()),
            "--broadcast-profile requires a nonempty name"
        );
        let broadcast = if let Some(index) = args.index("--broadcast")? {
            args.used[index] = true;
            let manual = args
                .values
                .get(index + 1)
                .filter(|value| !value.starts_with('-'))
                .map(|value| {
                    value
                        .parse::<uuid::Uuid>()
                        .context("--broadcast must be a source UUID")
                })
                .transpose()?;
            if manual.is_some() {
                ensure!(!args.used[index + 1], "--broadcast value already consumed");
                args.used[index + 1] = true;
                ensure!(
                    profile.is_none(),
                    "--broadcast SOURCE_UUID is registration-only; use --broadcast-profile NAME without a UUID to publish"
                );
            }
            Some(BroadcastOptions {
                source: manual.unwrap_or_else(uuid::Uuid::new_v4),
                profile,
                publish: manual.is_none(),
            })
        } else {
            profile.map(|name| BroadcastOptions {
                source: uuid::Uuid::new_v4(),
                profile: Some(name),
                publish: true,
            })
        };
        let enabled = args.flag("--web")?;
        let assets = args.value("--web-assets")?.map(PathBuf::from);
        let only = args.flag("--web-only")?;
        let port = args
            .value("--web-port")?
            .map(|value| value.parse().context("--web-port must be 0..65535"))
            .transpose()?;
        let auth = args.value("--web-auth")?;
        ensure!(
            auth.as_deref()
                .is_none_or(|auth| matches!(auth, "none" | "token")),
            "--web-auth must be none or token"
        );
        let host = args
            .value("--web-host")?
            .map(|value| value.parse().context("--web-host must be an IP address"))
            .transpose()?;
        let public_host = args
            .value("--web-public-host")?
            .map(|value| {
                value
                    .parse()
                    .context("--web-public-host must be an IP address")
            })
            .transpose()?;
        let allowed_hosts = args.value("--web-allowed-hosts")?.map(|value| {
            value
                .split(',')
                .map(str::trim)
                .filter(|host| !host.is_empty())
                .map(str::to_owned)
                .collect()
        });
        Ok(Self {
            broadcast,
            enabled,
            assets,
            only,
            port,
            auth,
            host,
            public_host,
            allowed_hosts,
        })
    }
}

pub(crate) enum Command {
    Play {
        source: PathBuf,
        presenter: bool,
        reload: bool,
        allow_playbooks: bool,
        web: WebOptions,
    },
    Check {
        source: PathBuf,
    },
    Host(HostOptions),
    Join(JoinOptions),
}

pub(crate) struct HostOptions {
    pub source: PathBuf,
    pub managed: bool,
    pub listen: String,
    pub cert: Option<PathBuf>,
    pub key: Option<PathBuf>,
    pub presenter_credential: PathBuf,
    pub audience_credential: Option<PathBuf>,
    pub public_read: bool,
    pub reload: bool,
    pub allow_playbooks: bool,
    pub web: WebOptions,
}

#[derive(Clone)]
pub(crate) struct JoinOptions {
    pub endpoint: String,
    pub ca: Option<PathBuf>,
    pub server_name: Option<String>,
    pub credential: Option<PathBuf>,
    pub mode: InteractionMode,
    pub presenter: bool,
}

impl Command {
    pub fn parse(name: &str, arguments: &[String]) -> Result<Self> {
        ensure!(
            name != "present",
            "present is a namespace; use explicit play, host, join or check"
        );
        let name = name.strip_prefix("present-").unwrap_or(name);
        let mut args = Arguments::new(arguments);
        let target = args
            .positional()?
            .context("a deck path or endpoint is required")?;
        match name {
            "play" => {
                let presenter = args.flag("--presenter")?;
                let reload = !args.flag("--no-reload")?;
                let allow_playbooks = args.playbooks_enabled()?;
                let web = WebOptions::parse(&mut args)?;
                args.finish()?;
                Ok(Self::Play {
                    source: target.into(),
                    presenter,
                    reload,
                    allow_playbooks,
                    web,
                })
            }
            "check" => {
                args.finish()?;
                Ok(Self::Check {
                    source: target.into(),
                })
            }
            "host" => {
                let managed = args.flag("--managed")?;
                let listen = args
                    .value("--listen")?
                    .unwrap_or_else(|| "127.0.0.1:7443".into());
                let cert = args.value("--cert")?.map(PathBuf::from);
                let key = args.value("--key")?.map(PathBuf::from);
                let presenter_credential = args
                    .value("--presenter-credential")?
                    .context(
                        "host requires --presenter-credential FILE (private scoped credential)",
                    )?
                    .into();
                let audience_credential = args.value("--audience-credential")?.map(PathBuf::from);
                let public_read = args.flag("--public-read")?;
                let reload = !args.flag("--no-reload")?;
                let allow_playbooks = args.playbooks_enabled()?;
                let web = WebOptions::parse(&mut args)?;
                ensure!(
                    public_read || audience_credential.is_some(),
                    "host requires --audience-credential FILE or explicit --public-read"
                );
                ensure!(
                    managed || (cert.is_some() && key.is_some()),
                    "standalone host requires --cert FILE and --key FILE"
                );
                ensure!(
                    !managed || (cert.is_none() && key.is_none() && listen == "127.0.0.1:7443"),
                    "--managed uses BMUX service transport; TLS listener options are standalone-only"
                );
                args.finish()?;
                Ok(Self::Host(HostOptions {
                    source: target.into(),
                    managed,
                    listen,
                    cert,
                    key,
                    presenter_credential,
                    audience_credential,
                    public_read,
                    reload,
                    allow_playbooks,
                    web,
                }))
            }
            "join" => {
                let ca = args.value("--ca")?.map(PathBuf::from);
                let server_name = args.value("--server-name")?;
                let credential = args.value("--credential")?.map(PathBuf::from);
                let mode = match args.value("--mode")?.as_deref().unwrap_or("receive-only") {
                    "receive-only" => InteractionMode::ReceiveOnly,
                    "submit-only" => InteractionMode::SubmitOnly,
                    "shared" => InteractionMode::Shared,
                    "independent" => InteractionMode::Independent,
                    other => bail!("invalid interaction mode: {other}"),
                };
                let presenter = args.flag("--presenter")?;
                ensure!(
                    !presenter || credential.is_some(),
                    "presenter requires --credential FILE"
                );
                if target.starts_with("bmux:") {
                    ensure!(
                        ca.is_none() && server_name.is_none(),
                        "BMUX join uses BMUX service transport"
                    );
                } else {
                    ensure!(
                        target.starts_with("tls://"),
                        "join endpoint must be tls://HOST:PORT or bmux:HOST_ID"
                    );
                    ensure!(
                        ca.is_some(),
                        "TLS join requires --ca FILE (explicit host trust)"
                    );
                }
                args.finish()?;
                Ok(Self::Join(JoinOptions {
                    endpoint: target,
                    ca,
                    server_name,
                    credential,
                    mode,
                    presenter,
                }))
            }
            other => bail!("unknown presentation command: {other}"),
        }
    }
}

struct Arguments<'a> {
    values: &'a [String],
    used: Vec<bool>,
}
impl<'a> Arguments<'a> {
    fn new(values: &'a [String]) -> Self {
        Self {
            values,
            used: vec![false; values.len()],
        }
    }
    fn positional(&mut self) -> Result<Option<String>> {
        // CLI registry normalizes arguments to positionals first. Do not interpret
        // option values as decks; direct invocation must use the same order.
        let Some(value) = self.values.first() else {
            return Ok(None);
        };
        ensure!(
            !value.starts_with('-'),
            "deck path or endpoint must precede options (use ./ for hyphen-prefixed paths)"
        );
        self.used[0] = true;
        Ok(Some(value.clone()))
    }
    fn index(&self, flag: &str) -> Result<Option<usize>> {
        let found: Vec<_> = self
            .values
            .iter()
            .enumerate()
            .filter(|(index, value)| !self.used[*index] && value.as_str() == flag)
            .map(|(index, _)| index)
            .collect();
        ensure!(found.len() <= 1, "duplicate {flag}");
        Ok(found.first().copied())
    }
    fn playbooks_enabled(&mut self) -> Result<bool> {
        // Retain the former opt-in as a compatibility alias, not a requirement.
        let allow = self.flag("--allow-playbooks")?;
        let disable = self.flag("--no-playbooks")?;
        ensure!(
            !(allow && disable),
            "--allow-playbooks conflicts with --no-playbooks"
        );
        Ok(!disable)
    }

    fn flag(&mut self, flag: &str) -> Result<bool> {
        if let Some(index) = self.index(flag)? {
            self.used[index] = true;
            Ok(true)
        } else {
            Ok(false)
        }
    }
    fn value(&mut self, flag: &str) -> Result<Option<String>> {
        let Some(index) = self.index(flag)? else {
            return Ok(None);
        };
        let value = self
            .values
            .get(index + 1)
            .filter(|value| !value.starts_with('-'))
            .with_context(|| format!("{flag} requires a value"))?;
        ensure!(!self.used[index + 1], "{flag} value already consumed");
        self.used[index] = true;
        self.used[index + 1] = true;
        Ok(Some(value.clone()))
    }
    fn finish(self) -> Result<()> {
        if let Some((_, value)) = self.values.iter().enumerate().find(|(i, _)| !self.used[*i]) {
            bail!("unexpected presentation argument: {value}");
        }
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    fn parse(name: &str, args: &[&str]) -> Result<Command> {
        Command::parse(
            name,
            &args.iter().map(ToString::to_string).collect::<Vec<_>>(),
        )
    }
    #[test]
    fn broadcast_is_explicit_validated_and_independent_of_web() {
        let source = "12345678-1234-4234-8234-123456789abc";
        let Command::Play { web, .. } = parse("play", &["deck.md", "--broadcast", source]).unwrap()
        else {
            panic!()
        };
        let broadcast = web.broadcast.unwrap();
        assert_eq!(broadcast.source.to_string(), source);
        assert!(!broadcast.publish);
        assert!(broadcast.profile.is_none());
        assert!(!web.enabled && !web.only);
        assert!(parse("play", &["deck.md", "--broadcast", "invalid"]).is_err());
        assert!(parse("join", &["bmux:host", "--broadcast", source]).is_err());
        assert!(parse("check", &["deck.md", "--broadcast", source]).is_err());
        for flag in ["--web", "--web-only"] {
            let Command::Play { web, .. } =
                parse("play", &["deck.md", flag, "--broadcast", source]).unwrap()
            else {
                panic!()
            };
            assert!(web.broadcast.is_some());
            assert_eq!(web.only, flag == "--web-only");
        }
    }

    #[test]
    fn turnkey_broadcast_uses_fresh_sources_and_explicit_profile_selection() {
        let mut sources = Vec::new();
        for flags in [
            vec!["--broadcast"],
            vec!["--broadcast", "--presenter"],
            vec!["--broadcast-profile", "stage"],
            vec!["--broadcast", "--broadcast-profile", "stage"],
        ] {
            let mut args = vec!["deck.md"];
            args.extend(flags);
            let Command::Play { web, .. } = parse("play", &args).unwrap() else {
                panic!()
            };
            assert!(!web.enabled && !web.only);
            let broadcast = web.broadcast.unwrap();
            assert!(broadcast.publish);
            assert_eq!(broadcast.source.get_version_num(), 4);
            assert_eq!(
                broadcast.profile.as_deref(),
                args.contains(&"stage").then_some("stage")
            );
            assert!(!sources.contains(&broadcast.source));
            sources.push(broadcast.source);
        }
        for args in [
            vec!["deck.md", "--broadcast-profile"],
            vec!["deck.md", "--broadcast-profile", " "],
            vec!["deck.md", "--broadcast", "--broadcast"],
            vec![
                "deck.md",
                "--broadcast",
                "12345678-1234-4234-8234-123456789abc",
                "--broadcast-profile",
                "stage",
            ],
        ] {
            assert!(parse("play", &args).is_err());
        }
        assert!(parse("join", &["bmux:host", "--broadcast-profile", "stage"]).is_err());
        assert!(parse("check", &["deck.md", "--broadcast"]).is_err());
    }

    #[test]
    fn explicit_play_only_and_namespace_is_not_a_leaf() {
        assert!(parse("present", &["deck.md"]).is_err());
        assert!(parse("present", &["play", "deck.md"]).is_err());
        for (name, args) in [("play", vec!["deck.md"]), ("present-play", vec!["deck.md"])] {
            assert!(matches!(
                parse(name, &args).unwrap(),
                Command::Play {
                    reload: true,
                    presenter: false,
                    ..
                }
            ));
        }
    }
    #[test]
    fn playbooks_default_on_with_creation_only_opt_out() {
        assert!(matches!(
            parse("play", &["deck.md"]).unwrap(),
            Command::Play {
                allow_playbooks: true,
                ..
            }
        ));
        assert!(matches!(
            parse("play", &["deck.md", "--allow-playbooks"]).unwrap(),
            Command::Play {
                allow_playbooks: true,
                ..
            }
        ));
        let Command::Host(options) = parse(
            "host",
            &[
                "deck.md",
                "--managed",
                "--presenter-credential",
                "p",
                "--public-read",
                "--allow-playbooks",
            ],
        )
        .unwrap() else {
            panic!("host")
        };
        assert!(options.allow_playbooks);
        assert!(matches!(
            parse("play", &["deck.md", "--no-playbooks"]).unwrap(),
            Command::Play {
                allow_playbooks: false,
                ..
            }
        ));
        for flags in [vec![], vec!["--no-playbooks"]] {
            let mut arguments = vec![
                "deck.md",
                "--managed",
                "--presenter-credential",
                "p",
                "--public-read",
            ];
            arguments.extend(flags.iter().copied());
            let Command::Host(options) = parse("host", &arguments).unwrap() else {
                panic!("host")
            };
            assert_eq!(options.allow_playbooks, flags.is_empty());
        }
        assert!(parse("play", &["deck.md", "--allow-playbooks", "--no-playbooks"]).is_err());
        assert!(parse("play", &["deck.md", "--no-playbooks", "--no-playbooks"]).is_err());
        assert!(parse("check", &["deck.md", "--no-playbooks"]).is_err());
        assert!(parse("join", &["bmux:host", "--no-playbooks"]).is_err());
        assert!(parse("check", &["deck.md", "--allow-playbooks"]).is_err());
        assert!(parse("join", &["bmux:host", "--allow-playbooks"]).is_err());
        assert!(
            parse(
                "play",
                &["deck.md", "--allow-playbooks", "--allow-playbooks"]
            )
            .is_err()
        );
    }
    #[test]
    fn hosting_is_private_unless_explicitly_public() {
        assert!(
            parse(
                "host",
                &["deck.md", "--managed", "--presenter-credential", "p"]
            )
            .is_err()
        );
        assert!(
            parse(
                "host",
                &[
                    "deck.md",
                    "--managed",
                    "--presenter-credential",
                    "p",
                    "--public-read"
                ]
            )
            .is_ok()
        );
        assert!(
            parse(
                "host",
                &["deck.md", "--presenter-credential", "p", "--public-read"]
            )
            .is_err()
        );
    }
    #[test]
    fn tls_requires_explicit_trust_and_rejects_unknown_flags() {
        assert!(parse("join", &["tls://localhost:7443"]).is_err());
        assert!(parse("join", &["tls://localhost:7443", "--ca", "host.pem"]).is_ok());
        assert!(
            parse(
                "join",
                &["tls://localhost:7443", "--ca", "host.pem", "--insecure"]
            )
            .is_err()
        );
        assert!(parse("play", &["deck.md", "--presenter", "--presenter"]).is_err());
    }
    #[test]
    fn web_flags_are_play_and_host_only_and_preserve_explicit_overrides() {
        let flags = [
            "deck.md",
            "--web-assets",
            "browser",
            "--web-only",
            "--web-port",
            "0",
            "--web-auth",
            "token",
            "--web-host",
            "127.0.0.1",
            "--web-public-host",
            "::1",
            "--web-allowed-hosts",
            "a.example,b.example",
        ];
        let Command::Play { web, .. } = parse("play", &flags).unwrap() else {
            panic!("expected play");
        };
        assert!(web.only);
        assert_eq!(web.assets, Some(PathBuf::from("browser")));
        assert_eq!(web.port, Some(0));
        assert_eq!(web.auth.as_deref(), Some("token"));
        assert_eq!(web.host, Some("127.0.0.1".parse().unwrap()));
        assert_eq!(web.public_host, Some("::1".parse().unwrap()));
        assert_eq!(
            web.allowed_hosts,
            Some(vec!["a.example".into(), "b.example".into()])
        );
        let mut host = flags.to_vec();
        host.extend(["--managed", "--presenter-credential", "p", "--public-read"]);
        assert!(matches!(parse("host", &host).unwrap(), Command::Host(_)));
        assert!(parse("join", &["bmux:host", "--web-only"]).is_err());
        assert!(parse("check", &["deck.md", "--web-assets", "browser"]).is_err());
        for invalid in [
            vec!["--web-port", "65536"],
            vec!["--web-auth", "password"],
            vec!["--web-host", "localhost"],
            vec!["--web-public-host", "example.com"],
            vec!["--web-only", "--web-only"],
            vec!["--web-assets"],
        ] {
            let mut args = vec!["deck.md"];
            args.extend(invalid);
            assert!(parse("play", &args).is_err());
        }
    }
    #[test]
    fn simple_web_flags_enable_without_assets() {
        for verb in ["play", "host"] {
            for flag in ["--web", "--web-only"] {
                let mut flags = vec!["deck.md", flag];
                if verb == "host" {
                    flags.extend([
                        "--managed",
                        "--presenter-credential",
                        "private",
                        "--public-read",
                    ]);
                }
                let web = match parse(verb, &flags).unwrap() {
                    Command::Play { web, .. } => web,
                    Command::Host(options) => options.web,
                    _ => panic!("expected play or host"),
                };
                assert_eq!(web.enabled, flag == "--web");
                assert_eq!(web.only, flag == "--web-only");
                assert!(web.assets.is_none());
            }
        }
        assert!(parse("join", &["bmux:host", "--web"]).is_err());
        assert!(parse("check", &["deck.md", "--web"]).is_err());
        assert!(parse("play", &["deck.md", "--web", "--web"]).is_err());
    }

    #[test]
    fn web_network_flags_do_not_imply_presenter_activation() {
        let Command::Play { web, .. } = parse("play", &["deck.md", "--web-port", "8080"]).unwrap()
        else {
            panic!("expected play");
        };
        assert!(!web.enabled);
        assert!(!web.only);
        assert!(web.assets.is_none());
    }
    #[test]
    fn supports_all_four_modes() {
        for mode in ["receive-only", "submit-only", "shared", "independent"] {
            assert!(parse("join", &["bmux:host", "--mode", mode]).is_ok());
        }
        assert!(parse("join", &["bmux:host", "--mode", "unknown"]).is_err());
        assert!(parse("join", &["bmux:host", "--presenter"]).is_err());
    }
}