rudof_cli 0.3.12

RDF and Knowledge Graphs processing tool
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
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
use crate::cli::parser::{Command as CliCommand, CommonArgsAll};
use crate::cli::wrappers::resolve_backend;
use crate::commands::{CommandContext, CommandFactory, extract_common};
use crate::shell::completer::ShellHelper;
use anyhow::{Context, Result, anyhow};
use clap::{CommandFactory as ClapCommandFactory, Parser};
use prefixmap::PrefixMap;
use rudof_lib::formats::{BackendSpec, InputSpec};
use rudof_lib::{DataStats, RudofConfig, TomlConfig};
use rustyline::error::ReadlineError;
use rustyline::history::DefaultHistory;
use rustyline::{Cmd, CompletionType, Config, Editor, EventHandler, KeyEvent};
use std::io;
use std::io::Write as _;
use std::process::Command;

pub(super) const PROMPT: &str = "rudof> ";
// Shown for continuation lines of a multi-line command, e.g. a SPARQL query
// spanning several lines inside an open quote. Padded to line up under
// `PROMPT`.
pub(super) const CONTINUATION_PROMPT: &str = "   ... ";

const BANNER: &str = concat!(
    "                 ",
    "\x1b[34m_\x1b[0m",
    "        ",
    "\x1b[34m___\x1b[0m\n",
    "                ",
    "\x1b[34m| |\x1b[0m",
    "      ",
    "\x1b[34m/ __)\x1b[0m\n",
    "  ",
    "\x1b[34m____\x1b[0m",
    " ",
    "\x1b[90m_   _\x1b[0m",
    "  ",
    "\x1b[34m_ | | \x1b[0m",
    "\x1b[90m___ \x1b[0m",
    "\x1b[34m| |__\x1b[0m\n",
    " ",
    "\x1b[34m/ ___)\x1b[0m",
    "\x1b[90m | | |\x1b[0m",
    "\x1b[34m/ || |\x1b[0m",
    "\x1b[90m/ _ \\\x1b[0m",
    "\x1b[34m|  __)\x1b[0m\n",
    "\x1b[34m| |\x1b[0m   ",
    "\x1b[90m| |_| \x1b[0m",
    "\x1b[34m( (_| |\x1b[0m",
    "\x1b[90m |_| \x1b[0m",
    "\x1b[34m| |\x1b[0m\n",
    "\x1b[34m|_|    \x1b[0m",
    "\x1b[90m\\____|\x1b[0m",
    "\x1b[34m\\____|\x1b[0m",
    "\x1b[90m\\___/\x1b[0m",
    "\x1b[34m|_|\x1b[0m",
);

/*const BANNER: &str = r"                 _        ___
                | |      / __)
  ____ _   _  _ | | ___ | |__
 / ___) | | |/ || |/ _ \|  __)
| |   | |_| ( (_| | |_| | |
|_|    \____|\____|\___/|_|";*/

// Re-parses a single REPL line into the same `CliCommand` enum used by the
// top-level `rudof` binary, without requiring a leading `rudof` token.
#[derive(Parser)]
#[command(name = "rudof", about = "rudof interactive shell commands", no_binary_name = true)]
struct ReplLine {
    #[command(subcommand)]
    command: CliCommand,
}

/// Reads one full command from `editor`, prompting for further lines (with
/// [`CONTINUATION_PROMPT`]) while the input read so far has unbalanced
/// quoting, so a multi-line inline value (e.g. a SPARQL query passed to
/// `query -q '...'`) can be typed directly instead of requiring a file.
/// `shlex::split` returning `None` is exactly the "still inside an open
/// quote" signal, since that's the same tokenizer [`dispatch`] uses to
/// split the finished line.
fn read_command(editor: &mut Editor<ShellHelper, DefaultHistory>) -> Result<String, ReadlineError> {
    let mut buffer = editor.readline(PROMPT)?;
    while !buffer.trim().is_empty() && shlex::split(&buffer).is_none() {
        // Continuation lines are their own `readline` call, so the helper
        // can't otherwise tell them apart from a fresh command line; tell it
        // explicitly so it doesn't color a continuation line's first word as
        // if it were a subcommand name.
        if let Some(helper) = editor.helper() {
            helper.set_continuation(true);
        }
        let result = editor.readline(CONTINUATION_PROMPT);
        if let Some(helper) = editor.helper() {
            helper.set_continuation(false);
        }
        match result {
            Ok(next) => {
                buffer.push('\n');
                buffer.push_str(&next);
            },
            Err(err @ ReadlineError::Eof) => {
                let _ = writeln!(
                    std::io::stderr(),
                    "Warning: input ended with an unterminated quote; discarding: {buffer}"
                );
                return Err(err);
            },
            Err(err) => return Err(err),
        }
    }
    Ok(buffer)
}

pub fn run(ctx: &mut CommandContext) -> Result<()> {
    let command_names = command_names();
    let endpoint_names = registered_endpoint_names(ctx);
    let config_keys = config_key_paths(ctx).unwrap_or_default();
    // List rather than Circular: on Tab with several matches (e.g. "sh" ->
    // shex/shacl/shapemap/shell), print all candidates instead of silently
    // filling in the first one and requiring repeated Tabs to cycle through
    // the rest.
    let config = Config::builder()
        .completion_type(CompletionType::List)
        .completion_show_all_if_ambiguous(true)
        // Belt-and-braces: if a command's output ever ends without a
        // trailing newline, this makes rustyline check the real cursor
        // column before drawing the next prompt and insert one itself,
        // rather than silently drawing over (and later erasing) the tail
        // of that output.
        .check_cursor_position(true)
        .build();
    let mut editor: Editor<ShellHelper, DefaultHistory> = Editor::with_config(config)?;
    editor.set_helper(Some(ShellHelper::new(command_names, endpoint_names, config_keys)));

    // A key to force-insert a newline instead of submitting, e.g. to keep
    // extending a recalled history entry that already parses as "complete"
    // (matched quoting) and would otherwise run on Enter. Ctrl-J is a plain
    // control byte every terminal delivers unambiguously; Alt-Enter is
    // added too since it works in many terminals, though some intercept it
    // for their own fullscreen toggle before it ever reaches this program —
    // Ctrl-J is the one to rely on.
    editor.bind_sequence(KeyEvent::ctrl('J'), EventHandler::Simple(Cmd::Newline));
    editor.bind_sequence(KeyEvent::alt('\r'), EventHandler::Simple(Cmd::Newline));

    let history_path = history_file();
    if let Some(path) = &history_path {
        // A missing history file is expected on first run; ignore the error.
        let _ = editor.load_history(path);
    }

    writeln!(ctx.writer, "{BANNER}")?;
    writeln!(ctx.writer, "Type 'help' for available commands, 'exit' to quit.")?;
    ctx.writer.flush()?;

    // Ctrl-C during a running command (as opposed to at the prompt, which
    // `rustyline` already handles below via `ReadlineError::Interrupted`)
    // would otherwise take the whole shell down with it — see
    // `crate::signals` for why and how this fixes it. Installed once, for
    // the life of the session; if it fails (very unlikely — the only
    // failure mode is the OS rejecting the `sigaction` call), the shell
    // still works, just without Ctrl-C cancellation.
    if let Err(err) = crate::signals::install_shell_ctrl_c_handler() {
        writeln!(
            std::io::stderr(),
            "Warning: could not install Ctrl-C handler ({err}); Ctrl-C during a running command will exit the shell"
        )?;
    }

    loop {
        match read_command(&mut editor) {
            Ok(line) => {
                let line = line.trim();
                if line.is_empty() {
                    continue;
                }
                if let Err(err) = editor.add_history_entry(line) {
                    writeln!(std::io::stderr(), "Warning: could not record history entry: {err}")?;
                }
                match line {
                    "exit" | "quit" => break,
                    "help" | "?" => print_help(ctx)?,
                    _ => {
                        // Clear any cancellation left over from a previous
                        // command (or a stray Ctrl-C at the idle prompt —
                        // see `crate::signals`) so this one starts fresh.
                        rudof_rdf::cancellation::reset();
                        if let Err(err) = dispatch_catching_panics(line, ctx) {
                            writeln!(
                                std::io::stderr(),
                                "{} {}",
                                crate::output::error_prefix(),
                                crate::output::format_error(&err)
                            )?;
                        }
                    },
                }
                ctx.writer.flush()?;
            },
            Err(ReadlineError::Interrupted) => continue,
            Err(ReadlineError::Eof) => break,
            Err(err) => {
                writeln!(std::io::stderr(), "Readline error: {err}")?;
                break;
            },
        }
    }

    if let Some(path) = &history_path
        && let Err(err) = editor.save_history(path)
    {
        writeln!(std::io::stderr(), "Warning: could not save shell history: {err}")?;
    }

    Ok(())
}

/// Runs [`dispatch`], additionally catching a panic raised deep inside a
/// command (a bug — an unexpected `unwrap()`/`expect()`/`todo!()`/index
/// out of bounds/etc., as opposed to a normal, expected `Result::Err`) so
/// that one broken command can't take down the whole interactive session.
/// It's reported the same way as any other command failure, and the shell
/// keeps running.
///
/// `AssertUnwindSafe` is required because `&mut CommandContext` isn't
/// `UnwindSafe` — a panic mid-mutation could in principle leave `ctx` in an
/// inconsistent state. That's an accepted tradeoff for an interactive
/// shell (same choice most REPLs make): surviving on a best-effort basis
/// after an internal bug is better than losing the whole session (loaded
/// data, schema, history, ...) over it. `ctx`'s state is deliberately left
/// as-is rather than auto-reset — most panics (like this file's original
/// motivating case, a `todo!()` reached only during *output* formatting)
/// happen after any state mutation for that command already completed, so
/// there's usually nothing to clean up, and guessing wrong would be worse
/// than leaving it alone.
fn dispatch_catching_panics(line: &str, ctx: &mut CommandContext) -> Result<()> {
    match std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| dispatch(line, ctx))) {
        Ok(result) => result,
        Err(payload) => Err(anyhow!("command panicked: {}", panic_message(&payload))),
    }
}

/// Extracts a human-readable message from a caught panic's payload, which
/// is almost always a `&str` (`panic!("literal")`) or `String`
/// (`panic!("{}", ...)`, `.unwrap()`, `.expect(...)`, `todo!()`), falling
/// back to a generic message for the rare payload of some other type.
///
/// Takes `&Box<dyn Any + Send>` rather than the seemingly-equivalent, more
/// idiomatic `&(dyn Any + Send)` deliberately: with the latter, the
/// `downcast_ref` calls below silently never match (a `&(dyn Any + Send)`
/// parameter's elided lifetime bound differs from `&Box<dyn Any + Send +
/// 'static>`'s, which breaks the coercion at the call site in a way that
/// doesn't error, it just makes every downcast fail) — always falling
/// through to the generic message below instead of the real one. Covered
/// by the tests in this module; don't "simplify" the parameter type.
fn panic_message(payload: &Box<dyn std::any::Any + Send>) -> String {
    if let Some(s) = payload.downcast_ref::<&str>() {
        (*s).to_string()
    } else if let Some(s) = payload.downcast_ref::<String>() {
        s.clone()
    } else {
        "no further information available".to_string()
    }
}

/// Parses `line` as a subcommand invocation and dispatches it through the
/// same [`CommandFactory`] used by the top-level CLI, reusing `ctx` so state
/// loaded by one command (RDF data, a schema, a shapemap...) is visible to
/// the next one.
fn dispatch(line: &str, ctx: &mut CommandContext) -> Result<()> {
    if let Some(command_line) = line.strip_prefix('!') {
        return run_external_command(command_line.trim(), ctx);
    }

    let mut tokens = shlex::split(line).ok_or_else(|| anyhow!("unable to parse line (check quoting): {line}"))?;
    if tokens.is_empty() {
        return Ok(());
    }

    if tokens[0] == "endpoint" {
        return handle_endpoint(&tokens[1..], ctx);
    }

    if tokens[0] == "reset" {
        return handle_reset(&tokens[1..], ctx);
    }

    if tokens[0] == "prefixes" {
        return handle_prefixes(&tokens[1..], ctx);
    }

    if tokens[0] == "config" && tokens.get(1).is_some_and(|sub| sub == "get" || sub == "set") {
        return handle_config(&tokens[1..], ctx);
    }

    // Shell-only `data ... --merge` flag: not part of `DataArgs` (so the
    // top-level CLI has no such flag), stripped out before clap ever sees
    // it. See `should_replace_data` below for what it controls.
    let merge = tokens[0] == "data" && take_merge_flag(&mut tokens);

    apply_bare_resource_convenience(&mut tokens);
    expand_prefixed_resource_tokens(&mut tokens, ctx);

    let parsed = match ReplLine::try_parse_from(&tokens) {
        Ok(repl_line) => repl_line.command,
        Err(err) => {
            writeln!(ctx.writer, "{err}")?;
            return Ok(());
        },
    };

    if matches!(parsed, CliCommand::Shell(_)) {
        writeln!(ctx.writer, "Already inside the shell.")?;
        return Ok(());
    }

    // Unlike the top-level CLI (one `data` call per process), the shell can
    // chain several `data` calls in the same session; loading would
    // otherwise *merge* into whatever RDF/PG data is already loaded, which
    // is surprising here since nothing about `data FILE` looks additive.
    // So the shell instead replaces the loaded data by default, unless the
    // new `--merge` flag says otherwise.
    let should_replace_data =
        !merge && matches!(&parsed, CliCommand::Data(args) if has_new_data_source(&args.common, &args.data));

    // `ctx.writer` is set up once for the whole shell session (defaulting
    // to the terminal), so a command's own `-o`/`--output-file` would
    // otherwise be ignored and its output would print to the terminal
    // instead of being written to that file. Redirect just for this one
    // command's execution when it asks for a file.
    let common = extract_common(&parsed);
    let output_path = common.output().cloned().filter(|path| path.to_string_lossy() != "-");
    let force_overwrite = common.force_overwrite();

    // For the "load a resource and dump it" commands, the shell prints a
    // short stats line by default instead of the full dump — the full dump
    // is still available via `-o FILE`, handled below.
    let stats_kind = output_path.is_none().then(|| StatsKind::of(&parsed)).flatten();

    let command = CommandFactory::create(parsed)?;

    if should_replace_data {
        ctx.rudof.reset_data().execute();
    }

    if let Some(kind) = stats_kind {
        let previous_writer = std::mem::replace(&mut ctx.writer, Box::new(io::sink()));
        let result = command.execute(ctx);
        ctx.writer = previous_writer;
        result?;
        writeln!(ctx.writer, "{}", kind.stats_line(ctx))?;
        return Ok(());
    }

    let Some(path) = output_path else {
        return command.execute(ctx);
    };

    let (file_writer, _color) = crate::output::get_writer(&Some(path.clone()), force_overwrite)?;
    let previous_writer = std::mem::replace(&mut ctx.writer, file_writer);

    let result = command.execute(ctx).and_then(|()| Ok(ctx.writer.flush()?));

    ctx.writer = previous_writer;
    result?;

    writeln!(ctx.writer, "Output saved in {}", path.display())?;
    Ok(())
}

/// The subset of subcommands that load a resource (RDF/PG data, a schema,
/// ...) and, by default, dump it in full — in the shell these instead print
/// a short stats line about what got loaded, since a session tends to chain
/// several such commands and the full dump mostly just scrolls past.
#[derive(Clone, Copy)]
enum StatsKind {
    Data,
    Shex,
    Shacl,
    DCTap,
    Pgschema,
    Service,
}

impl StatsKind {
    /// Returns the stats kind for `command`, but only when the line actually
    /// loads a new resource — a bare call with nothing new to load (e.g.
    /// `shex` alone) falls through to the command's normal behavior of
    /// re-showing whatever is already loaded in full, exactly as before this
    /// feature existed.
    fn of(command: &CliCommand) -> Option<Self> {
        match command {
            CliCommand::Data(args) => has_new_data_source(&args.common, &args.data).then_some(Self::Data),
            CliCommand::Shex(args) => args.schema.is_some().then_some(Self::Shex),
            CliCommand::Shacl(args) => {
                (has_new_data_source(&args.common, &args.data) || args.shapes.is_some()).then_some(Self::Shacl)
            },
            CliCommand::DCTap(args) => args.file.is_some().then_some(Self::DCTap),
            CliCommand::Pgschema(args) => args.schema.is_some().then_some(Self::Pgschema),
            CliCommand::Service(args) => args.service.is_some().then_some(Self::Service),
            _ => None,
        }
    }

    fn stats_line(self, ctx: &CommandContext) -> String {
        match self {
            Self::Data => match ctx.rudof.data_stats() {
                Some(DataStats::Rdf { triples }) => format!("{triples} triple(s) loaded"),
                Some(DataStats::Pg { nodes, edges }) => format!("{nodes} node(s), {edges} edge(s) loaded"),
                None => "No data loaded".to_string(),
            },
            Self::Shex => match ctx.rudof.shex_schema().and_then(|schema| schema.shapes()) {
                Some(shapes) => format!("{} shape(s) loaded", shapes.len()),
                None => "No shapes loaded".to_string(),
            },
            Self::Shacl => match ctx.rudof.shacl_shapes() {
                Some(shapes) => format!("{} shape(s) loaded", shapes.iter().count()),
                None => "No shapes loaded".to_string(),
            },
            Self::DCTap => match ctx.rudof.dctap() {
                Some(dctap) => format!("{} shape(s) loaded", dctap.shapes().count()),
                None => "No shapes loaded".to_string(),
            },
            Self::Pgschema => match ctx.rudof.pg_schema() {
                Some(schema) => format!(
                    "{} node type(s), {} edge type(s) loaded",
                    schema.node_type_count(),
                    schema.edge_type_count()
                ),
                None => "No schema loaded".to_string(),
            },
            Self::Service => match ctx.rudof.service_description() {
                Some(service) => format!(
                    "{} graph(s), {} feature(s) loaded",
                    service.available_graphs_count(),
                    service.feature_count()
                ),
                None => "No service description loaded".to_string(),
            },
        }
    }
}

/// Mirrors the `has_data_source` check each of [`DataCommand`]/[`ShaclCommand`]
/// makes internally (`rudof_cli/src/commands/data.rs`,
/// `rudof_cli/src/commands/shacl.rs`) to decide whether it's about to load
/// new RDF data, so the shell can tell "loading" and "just re-showing what's
/// already loaded" apart the same way those commands do.
///
/// [`DataCommand`]: crate::commands::DataCommand
/// [`ShaclCommand`]: crate::commands::ShaclCommand
fn has_new_data_source(common: &CommonArgsAll, data: &[InputSpec]) -> bool {
    !data.is_empty() || matches!(resolve_backend(common), BackendSpec::Endpoint(_))
}

/// Shell-only `endpoint [NAME|FILE.toml]` command.
///
/// With no argument, reports the endpoint activated (if any) by an earlier
/// `endpoint NAME` call in this session, or points the user at the command
/// otherwise. With a `NAME` argument, activates the matching endpoint
/// registered in the rudof TOML config for the rest of the session (reusing
/// the same mechanism as `data --endpoint NAME`), so later commands that
/// query RDF data (e.g. `query`, `node`) can rely on it without repeating
/// `--endpoint` themselves. With a `FILE.toml` argument instead, registers a
/// new endpoint description loaded from that local file (under a name
/// derived from the file's stem) and activates it the same way.
fn handle_endpoint(args: &[String], ctx: &mut CommandContext) -> Result<()> {
    match args {
        [] => show_active_endpoint(ctx),
        [arg] if arg.to_lowercase().ends_with(".toml") => register_endpoint_from_file(arg, ctx),
        [name] => activate_endpoint(name, ctx),
        _ => {
            writeln!(ctx.writer, "Usage: endpoint [NAME|FILE.toml]")?;
            Ok(())
        },
    }
}

/// Loads an endpoint description from `path` (a local TOML file, see
/// `rudof_rdf/endpoints/*.toml` for examples of the expected shape),
/// registers it under its own `name` field, and activates it — like
/// `activate_endpoint`, but for a brand-new endpoint rather than one already
/// known to the loaded config. Session-only: not written back to
/// `rudof.toml`; use `rudof config -o rudof.toml` to make it permanent.
fn register_endpoint_from_file(path: &str, ctx: &mut CommandContext) -> Result<()> {
    let mut rdf_data = ctx.rudof.config().execute().rdf_data().clone();
    let name = rdf_data
        .load_endpoint_description(path)
        .map_err(|err| anyhow!("Failed to load endpoint description from '{path}': {err}"))?;

    let config = ctx.rudof.config().execute().clone().with_rdf_data(rdf_data);
    ctx.rudof.update_config(config).execute();

    writeln!(ctx.writer, "Registered endpoint '{name}' from {path}")?;
    activate_endpoint(&name, ctx)
}

fn show_active_endpoint(ctx: &mut CommandContext) -> Result<()> {
    let Some(name) = ctx.active_endpoint.clone() else {
        writeln!(ctx.writer, "No endpoint is currently active.")?;
        writeln!(ctx.writer, "Use 'endpoint NAME' to activate one.")?;
        writeln!(ctx.writer, "{}", registered_endpoints_line(ctx))?;
        return Ok(());
    };

    match endpoint_url(ctx, &name) {
        Some(url) => writeln!(ctx.writer, "Active endpoint: {name} ({url})")?,
        None => writeln!(ctx.writer, "Active endpoint: {name}")?,
    }
    Ok(())
}

fn activate_endpoint(name: &str, ctx: &mut CommandContext) -> Result<()> {
    // `name` is matched case-insensitively (`wikidata`/`Wikidata`/`WikiData`
    // all resolve the same endpoint), but the canonical, capitalized name is
    // what gets stored/displayed/passed onward from here.
    let Some(canonical_name) = canonical_endpoint_name(ctx, name) else {
        writeln!(ctx.writer, "Unknown endpoint '{name}'.")?;
        writeln!(ctx.writer, "{}", registered_endpoints_line(ctx))?;
        return Ok(());
    };

    ctx.rudof.load_data().with_endpoint(&canonical_name).execute()?;
    ctx.active_endpoint = Some(canonical_name.clone());

    let url = endpoint_url(ctx, &canonical_name).unwrap_or_default();
    writeln!(ctx.writer, "Active endpoint: {canonical_name} ({url})")?;
    Ok(())
}

fn canonical_endpoint_name(ctx: &CommandContext, name: &str) -> Option<String> {
    ctx.rudof
        .config()
        .execute()
        .rdf_data()
        .find_endpoint(name)
        .map(|e| e.name().to_string())
}

fn endpoint_url(ctx: &CommandContext, name: &str) -> Option<String> {
    ctx.rudof
        .config()
        .execute()
        .rdf_data()
        .find_endpoint(name)
        .map(|e| e.query_url().to_string())
}

/// Shell-only `reset [TARGET...]` command.
///
/// With no argument (or `all`), clears every piece of session state loaded so
/// far — RDF data, schemas, shapemap, results, the active endpoint, ... —
/// the same as starting a fresh shell. With one or more target names, clears
/// only the state owned by the matching `rudof` subcommand, leaving
/// everything else untouched.
const RESET_TARGETS: &[&str] = &[
    "data",
    "shex",
    "shacl",
    "pgschema",
    "shapemap",
    "dctap",
    "service",
    "query",
    "sparql",
    "typemap",
    "rdf-config",
    "endpoint",
];

fn handle_reset(args: &[String], ctx: &mut CommandContext) -> Result<()> {
    match args {
        [] => reset_everything(ctx)?,
        [only] if only == "all" => reset_everything(ctx)?,
        targets => {
            let unknown: Vec<&str> = targets
                .iter()
                .map(String::as_str)
                .filter(|target| !RESET_TARGETS.contains(target))
                .collect();
            if !unknown.is_empty() {
                writeln!(ctx.writer, "Unknown reset target(s): {}.", unknown.join(", "))?;
                writeln!(ctx.writer, "Valid targets: {}, or 'all'.", RESET_TARGETS.join(", "))?;
                return Ok(());
            }

            for target in targets {
                reset_target(target, ctx);
            }
            writeln!(ctx.writer, "Reset: {}.", targets.join(", "))?;
        },
    }
    Ok(())
}

fn reset_everything(ctx: &mut CommandContext) -> Result<()> {
    ctx.rudof.reset_all().execute();
    ctx.active_endpoint = None;
    writeln!(ctx.writer, "Reset all session state.")?;
    Ok(())
}

fn reset_target(target: &str, ctx: &mut CommandContext) {
    match target {
        "data" => ctx.rudof.reset_data().execute(),
        "shex" => ctx.rudof.reset_shex_schema().execute(),
        "shacl" => ctx.rudof.reset_shacl_shapes().execute(),
        "pgschema" => ctx.rudof.reset_pg_schema().execute(),
        "shapemap" => ctx.rudof.reset_shapemap().execute(),
        "dctap" => ctx.rudof.reset_dctap().execute(),
        "service" => ctx.rudof.reset_service_description().execute(),
        "query" => {
            ctx.rudof.reset_sparql_query().execute();
            ctx.rudof.reset_query_results().execute();
        },
        "sparql" => ctx.rudof.reset_sparql_query().execute(),
        "typemap" => ctx.rudof.reset_typemap().execute(),
        "rdf-config" => ctx.rudof.reset_rdf_config().execute(),
        "endpoint" => ctx.active_endpoint = None,
        _ => unreachable!("target validated against RESET_TARGETS by handle_reset"),
    }
}

/// Shell-only `prefixes [add ALIAS IRI | rm ALIAS | rename OLD NEW | copy OLD NEW]` command.
///
/// With no argument, shows the current default `PrefixMap` -- the prefix
/// declarations assumed and prepended by default to RDF data, SPARQL
/// queries, ShEx schemas and SHACL shapes, independently of whatever
/// prefixes a loaded resource already declares.
fn handle_prefixes(args: &[String], ctx: &mut CommandContext) -> Result<()> {
    match args {
        [] => show_prefixes(ctx),
        [add, alias, iri] if add == "add" => {
            ctx.rudof.add_prefix(alias, iri).execute()?;
            writeln!(ctx.writer, "Added prefix {alias}: <{iri}>")?;
            Ok(())
        },
        [rm, alias] if rm == "rm" => {
            ctx.rudof.remove_prefix(alias).execute()?;
            writeln!(ctx.writer, "Removed prefix {alias}")?;
            Ok(())
        },
        [rename, old_alias, new_alias] if rename == "rename" => {
            ctx.rudof.rename_prefix(old_alias, new_alias).execute()?;
            writeln!(ctx.writer, "Renamed prefix {old_alias} to {new_alias}")?;
            Ok(())
        },
        [copy, old_alias, new_alias] if copy == "copy" => {
            ctx.rudof.copy_prefix(old_alias, new_alias).execute()?;
            writeln!(ctx.writer, "Copied prefix {old_alias} to {new_alias}")?;
            Ok(())
        },
        _ => {
            writeln!(
                ctx.writer,
                "Usage: prefixes [add ALIAS IRI | rm ALIAS | rename OLD NEW | copy OLD NEW]"
            )?;
            Ok(())
        },
    }
}

fn show_prefixes(ctx: &mut CommandContext) -> Result<()> {
    let prefixes = ctx.rudof.prefixes().execute();
    if prefixes.is_empty() {
        writeln!(ctx.writer, "No default prefixes are defined.")?;
        return Ok(());
    }
    write!(ctx.writer, "{prefixes}")?;
    Ok(())
}

/// Shell-only `config get [KEY]` / `config set KEY VALUE` commands.
///
/// `KEY` is a dot-separated path into the effective TOML configuration (e.g.
/// `base_iri`, or `shex_validator.max_steps`). `config` with no `get`/`set`
/// subcommand falls through to the ordinary top-level `config` command,
/// which dumps the whole configuration as TOML.
fn handle_config(args: &[String], ctx: &mut CommandContext) -> Result<()> {
    match args {
        [get] if get == "get" => show_config(None, ctx),
        [get, key] if get == "get" => show_config(Some(key), ctx),
        [set, key, value] if set == "set" => set_config(key, value, ctx),
        _ => {
            writeln!(ctx.writer, "Usage: config get [KEY] | config set KEY VALUE")?;
            Ok(())
        },
    }
}

/// Returns the effective configuration (defaults merged with whatever was
/// loaded) as a parsed [`toml::Value`] tree — the same tree `config get`/
/// `config set` traverse by dotted path, and what [`config_key_paths`] walks
/// to build the shell's Tab-completion candidates for `config get`/`set`.
fn effective_config_root(ctx: &CommandContext) -> Result<toml::Value> {
    let toml_str = ctx.rudof.config().execute().to_toml_string()?;
    Ok(toml::from_str(&toml_str)?)
}

fn show_config(key: Option<&str>, ctx: &mut CommandContext) -> Result<()> {
    let Some(key) = key else {
        writeln!(ctx.writer, "{}", ctx.rudof.config().execute().to_toml_string()?)?;
        return Ok(());
    };

    let root = effective_config_root(ctx)?;
    match config_lookup(&root, key) {
        Some(value) => {
            writeln!(ctx.writer, "{}", format_config_value(value))?;
            Ok(())
        },
        None => unknown_config_key(key, ctx),
    }
}

fn set_config(key: &str, value: &str, ctx: &mut CommandContext) -> Result<()> {
    let mut root = effective_config_root(ctx)?;

    if config_set_path(&mut root, key, parse_config_scalar(value)).is_none() {
        return unknown_config_key(key, ctx);
    }

    let updated_toml = toml::to_string(&root)?;
    let updated_config =
        RudofConfig::from_toml_str(&updated_toml).map_err(|err| anyhow!("invalid value for '{key}': {err}"))?;

    // Re-derive the effective TOML from the *parsed* config, not the raw
    // table just edited, to confirm the key was actually recognized: a
    // typo'd key would otherwise be silently dropped by serde (no section
    // in this config uses `deny_unknown_fields`) and have no effect.
    let effective_toml = updated_config.to_toml_string()?;
    let effective_root: toml::Value = toml::from_str(&effective_toml)?;
    let Some(confirmed) = config_lookup(&effective_root, key) else {
        return unknown_config_key(key, ctx);
    };
    let confirmed = confirmed.clone();

    // `logging.level` doesn't just live in `RudofConfig` — it drives the
    // actual `tracing` filter, which `$RUST_LOG` can't be changed at
    // runtime to do (see `crate::logging`). Apply it live, and reject the
    // value up front if it's not a valid filter, before it's committed.
    if key == "logging.level"
        && let Some(level) = confirmed.as_str()
    {
        crate::logging::set_level(level).map_err(|err| anyhow!("invalid value for '{key}': {err}"))?;
    }

    ctx.rudof.update_config(updated_config).execute();
    writeln!(ctx.writer, "{key} = {}", format_config_value(&confirmed))?;
    Ok(())
}

fn unknown_config_key(key: &str, ctx: &mut CommandContext) -> Result<()> {
    writeln!(ctx.writer, "Unknown config key '{key}'.")?;
    writeln!(ctx.writer, "Use 'config' with no arguments to see all available keys.")?;
    Ok(())
}

fn config_lookup<'a>(root: &'a toml::Value, key: &str) -> Option<&'a toml::Value> {
    key.split('.').try_fold(root, |current, segment| current.get(segment))
}

/// Assigns `new_value` at the dotted `key` path, in place, creating the leaf
/// if needed (e.g. an unset `Option` field omitted from the TOML dump) as
/// long as every parent segment already exists as a table. Returns `None`
/// without modifying `root` if some parent segment doesn't resolve.
fn config_set_path(root: &mut toml::Value, key: &str, new_value: toml::Value) -> Option<()> {
    let mut current = root;
    let mut segments = key.split('.').peekable();
    while let Some(segment) = segments.next() {
        if segments.peek().is_none() {
            current.as_table_mut()?.insert(segment.to_string(), new_value);
            return Some(());
        }
        current = current.get_mut(segment)?;
    }
    None
}

/// Every dotted key path reachable in the effective configuration (both
/// intermediate table paths like `shex_validator` and leaf paths like
/// `shex_validator.max_steps`), sorted — used as `config get`/`config set`'s
/// Tab-completion candidates. Captured once at shell startup, the same way
/// [`registered_endpoint_names`] is, so it won't pick up a key that only
/// becomes visible later in the session (e.g. an optional field that's unset
/// — and so omitted from the TOML tree entirely — until first set via
/// `config set`).
fn config_key_paths(ctx: &CommandContext) -> Result<Vec<String>> {
    let root = effective_config_root(ctx)?;
    let mut paths = Vec::new();
    collect_config_key_paths(&root, "", &mut paths);
    paths.sort_unstable();
    Ok(paths)
}

fn collect_config_key_paths(value: &toml::Value, prefix: &str, out: &mut Vec<String>) {
    let toml::Value::Table(table) = value else {
        return;
    };
    for (key, child) in table {
        let path = if prefix.is_empty() {
            key.clone()
        } else {
            format!("{prefix}.{key}")
        };
        out.push(path.clone());
        collect_config_key_paths(child, &path, out);
    }
}

fn parse_config_scalar(value: &str) -> toml::Value {
    if let Ok(b) = value.parse::<bool>() {
        toml::Value::Boolean(b)
    } else if let Ok(i) = value.parse::<i64>() {
        toml::Value::Integer(i)
    } else if let Ok(f) = value.parse::<f64>() {
        toml::Value::Float(f)
    } else {
        toml::Value::String(value.to_string())
    }
}

fn format_config_value(value: &toml::Value) -> String {
    match value {
        toml::Value::String(s) => s.clone(),
        other => other.to_string(),
    }
}

fn registered_endpoint_names(ctx: &CommandContext) -> Vec<String> {
    let mut names: Vec<String> = ctx
        .rudof
        .config()
        .execute()
        .rdf_data()
        .endpoints()
        .keys()
        .cloned()
        .collect();
    names.sort_unstable();
    names
}

fn registered_endpoints_line(ctx: &CommandContext) -> String {
    let names = registered_endpoint_names(ctx);
    if names.is_empty() {
        "No endpoints are registered in the config.".to_string()
    } else {
        format!("Registered endpoints: {}", names.join(", "))
    }
}

/// Commands whose primary argument is otherwise only settable through a
/// named flag. Inside the shell (never the top-level CLI, which this
/// doesn't touch), a line consisting of just `<command> <value>` — nothing
/// else — is treated as shorthand for `<command> <flag> <value>`, e.g.
/// `shex examples/user.shex` behaves like `shex -s examples/user.shex`,
/// and `node :alice` behaves like `node -n :alice`.
///
/// This only fires when the value is the *only* token after the command
/// name, so it can never be confused with a value belonging to some other
/// flag; combine it with any other flag and it must be spelled out.
const BARE_RESOURCE_FLAG: &[(&str, &str)] = &[
    ("shex", "-s"),
    ("shacl", "-s"),
    ("shapemap", "-m"),
    ("pgschema", "-s"),
    ("dctap", "-s"),
    ("service", "-s"),
    ("materialize", "-s"),
    ("generate", "-s"),
    ("rdf-config", "-s"),
    ("node", "-n"),
    ("sparql", "-q"),
];

/// Runs `command_line` in the system shell, e.g. `! ls` or `!code file.shex`.
///
/// The line is handed to a real shell (`$SHELL`, falling back to `/bin/sh`
/// on Unix; `cmd /C` on Windows) rather than tokenized ourselves, so
/// pipes/redirects/globs work exactly like they would outside the shell.
/// Stdio is inherited, so interactive commands (an editor, a pager) work
/// too. Only the failure to *launch* the shell itself is an error here — a
/// nonzero exit from the command is left to speak for itself, the same way
/// a plain shell would report it.
fn run_external_command(command_line: &str, ctx: &mut CommandContext) -> Result<()> {
    if command_line.is_empty() {
        writeln!(ctx.writer, "No command given after '!'.")?;
        return Ok(());
    }

    // Flush any buffered rudof output first so it can't appear interleaved
    // after the external command's own (unbuffered, inherited) output.
    ctx.writer.flush()?;

    system_shell(command_line)
        .status()
        .with_context(|| format!("failed to run external command: {command_line}"))?;

    Ok(())
}

#[cfg(not(windows))]
fn system_shell(command_line: &str) -> Command {
    let shell = std::env::var("SHELL").unwrap_or_else(|_| "/bin/sh".to_string());
    let mut command = Command::new(shell);
    command.arg("-c").arg(command_line);
    command
}

#[cfg(windows)]
fn system_shell(command_line: &str) -> Command {
    let mut command = Command::new("cmd");
    command.arg("/C").arg(command_line);
    command
}

/// Removes a bare `--merge` token from `tokens`, if present, and reports
/// whether it was there. Must run before [`apply_bare_resource_convenience`]
/// so a line like `data FILE --merge` still counts as "exactly one bare
/// value" once `--merge` is out of the way.
fn take_merge_flag(tokens: &mut Vec<String>) -> bool {
    let had_merge = tokens.iter().any(|token| token == "--merge");
    tokens.retain(|token| token != "--merge");
    had_merge
}

fn apply_bare_resource_convenience(tokens: &mut Vec<String>) {
    let [command, value] = tokens.as_slice() else {
        return;
    };
    if value.starts_with('-') {
        return;
    }
    if let Some((_, flag)) = BARE_RESOURCE_FLAG.iter().find(|(name, _)| name == command) {
        tokens.insert(1, (*flag).to_string());
    }
}

/// Flags whose value names a remote resource to fetch — a schema, shapemap
/// or query, always by URL/path — as opposed to `-n` (a node identifier,
/// deliberately excluded: that's an RDF term reference resolved by the
/// loaded document's own prefixes, not a resource to fetch).
const RESOURCE_VALUE_FLAGS: &[&str] = &["-s", "-q", "-m"];

/// Expands a prefixed name (e.g. `es:E10`) in the value of any
/// [`RESOURCE_VALUE_FLAGS`] flag into the full IRI it stands for, using the
/// session's default prefixes and, if one is active, the active endpoint's
/// own prefixes — so e.g. `shex es:E10` can load
/// `https://www.wikidata.org/wiki/Special:EntitySchemaText/E10` once `es` is
/// registered (as it is by the bundled Wikidata endpoint) without typing the
/// full URL. Runs after [`apply_bare_resource_convenience`], so a bare value
/// like `shex es:E10` (already turned into `shex -s es:E10` by then) is
/// covered the same as an explicit `-s`. Shell-only: the top-level CLI has
/// no such expansion.
fn expand_prefixed_resource_tokens(tokens: &mut [String], ctx: &CommandContext) {
    let mut i = 0;
    while i < tokens.len() {
        if RESOURCE_VALUE_FLAGS.contains(&tokens[i].as_str())
            && let Some(expanded) = tokens
                .get(i + 1)
                .and_then(|value| resolve_prefixed_resource(value, ctx))
        {
            tokens[i + 1] = expanded;
        }
        i += 1;
    }
}

/// If `token` is a prefixed name (`alias:local`, e.g. `es:E10`) whose
/// `alias` is a known prefix — checked against the session's default
/// prefixes first, then the active endpoint's prefixes — returns the
/// expanded IRI as a string. `None` for anything else (an existing URL, a
/// file path, an unregistered alias, ...), leaving `token` to be parsed
/// as a normal `InputSpec`.
fn resolve_prefixed_resource(token: &str, ctx: &CommandContext) -> Option<String> {
    let default_prefixes = ctx.rudof.prefixes().execute();
    let endpoint_prefixes = active_endpoint_prefixmap(ctx);
    crate::cli::prefix_expand::resolve_prefixed_resource(token, &default_prefixes, endpoint_prefixes.as_ref())
}

/// The `PrefixMap` bundled with the currently active endpoint (`endpoint
/// NAME`/`endpoint FILE.toml`), if any endpoint is active.
fn active_endpoint_prefixmap(ctx: &CommandContext) -> Option<PrefixMap> {
    let name = ctx.active_endpoint.as_deref()?;
    ctx.rudof
        .config()
        .execute()
        .rdf_data()
        .find_endpoint(name)
        .map(|endpoint| endpoint.prefixmap().clone())
}

fn print_help(ctx: &mut CommandContext) -> Result<()> {
    let help = ReplLine::command().render_long_help();
    writeln!(ctx.writer, "{help}")?;
    writeln!(ctx.writer, "Shell-only commands:")?;
    writeln!(ctx.writer, "  help, ?        Show this help message")?;
    writeln!(ctx.writer, "  exit, quit     Exit the shell")?;
    writeln!(
        ctx.writer,
        "  !<command>     Run <command> in the system shell (e.g. !ls, !code file.shex)"
    )?;
    writeln!(
        ctx.writer,
        "  endpoint [NAME]  Show the active SPARQL endpoint, or activate a registered one"
    )?;
    writeln!(
        ctx.writer,
        "  reset [TARGET...]  Clear session state ({}), or everything with no argument",
        RESET_TARGETS.join(", ")
    )?;
    writeln!(
        ctx.writer,
        "  config get [KEY]      Show the whole config, or one dotted key (e.g. shex_validator.max_steps)"
    )?;
    writeln!(
        ctx.writer,
        "  config set KEY VALUE  Change one config value for the rest of the session"
    )?;
    writeln!(
        ctx.writer,
        "  prefixes [add ALIAS IRI | rm ALIAS | rename OLD NEW | copy OLD NEW]"
    )?;
    writeln!(
        ctx.writer,
        "                     Show, or manage, the default prefix declarations"
    )?;
    writeln!(
        ctx.writer,
        "  data FILE --merge  Merge FILE into the currently loaded data instead of replacing it"
    )?;
    Ok(())
}

fn command_names() -> Vec<String> {
    let mut names: Vec<String> = ReplLine::command()
        .get_subcommands()
        .map(|cmd| cmd.get_name().to_string())
        .collect();
    names.push("help".to_string());
    names.push("exit".to_string());
    names.push("quit".to_string());
    names.push("endpoint".to_string());
    names.push("reset".to_string());
    names.push("prefixes".to_string());
    names
}

fn history_file() -> Option<std::path::PathBuf> {
    dirs::home_dir().map(|home| home.join(".rudof_history"))
}

#[cfg(test)]
mod tests {
    use super::panic_message;
    use std::panic::AssertUnwindSafe;

    #[test]
    fn extracts_message_from_a_str_panic_payload() {
        let payload = std::panic::catch_unwind(AssertUnwindSafe(|| panic!("boom"))).unwrap_err();
        assert_eq!(panic_message(&payload), "boom");
    }

    #[test]
    fn extracts_message_from_a_string_panic_payload() {
        let payload = std::panic::catch_unwind(AssertUnwindSafe(|| panic!("boom {}", 42))).unwrap_err();
        assert_eq!(panic_message(&payload), "boom 42");
    }

    #[test]
    fn falls_back_to_a_generic_message_for_other_payload_types() {
        let payload = std::panic::catch_unwind(AssertUnwindSafe(|| std::panic::panic_any(404))).unwrap_err();
        assert_eq!(panic_message(&payload), "no further information available");
    }
}