[ext] more external-access work

tstack · tstack · commit 22a920d12860 · 2025-09-12T16:19:52.000-07:00
diff --git a/configure.ac b/configure.ac
@@ -134,6 +134,16 @@ AS_IF([test "x$with_system_doctest" != "xyes"], [
     CPPFLAGS="-I\$(top_srcdir)/src/third-party/doctest-root $CPPFLAGS"
 ])
 
+AC_ARG_WITH([cargo],
+    AS_HELP_STRING(
+        [--without-cargo],
+        [Skip the Rust extensions]
+    ),
+    AS_IF([test "x$with_cargo" = "xno"], [
+        CARGO_CMD=""
+    ]),
+    []
+)
 
 LNAV_WITH_JEMALLOC
 
diff --git a/docs/notes/log2src.md b/docs/notes/log2src.md
@@ -70,3 +70,8 @@ Steps:
 1. Show that the editor has moved to the source code
    containing the breakpoint and the variables passed to
    the log statement are shown.
+
+Implementation tasks:
+
+- [X] Make lnav remotely-controllable
+- [X] Add support for breakpoints
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -834,6 +834,7 @@ target_compile_options(diag PRIVATE ${CURSES_CFLAGS})
 add_custom_command(
         OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/target/release/liblnav_rs_ext.a
         COMMAND env CARGO_TARGET_DIR=target cargo build --manifest-path ${CMAKE_CURRENT_SOURCE_DIR}/third-party/lnav-rs-ext/Cargo.toml --package lnav-rs-ext --release
+        DEPENDS third-party/lnav-rs-ext/src/lib.rs third-party/lnav-rs-ext/src/ext_access.rs
 )
 add_custom_target(
         lnav_rs_ext
diff --git a/src/cmds.scripting.cc b/src/cmds.scripting.cc
@@ -474,6 +474,7 @@ com_sh(exec_context& ec, std::string cmdline, std::vector<std::string>& args)
     return Ok(std::string());
 }
 
+#ifdef HAVE_RUST_DEPS
 namespace lnav_rs_ext {
 
 ::rust::String
@@ -529,12 +530,14 @@ execute_external_command(::rust::String rs_src, ::rust::String rs_script)
 }
 
 }  // namespace lnav_rs_ext
+#endif
 
 static Result<std::string, lnav::console::user_message>
 com_external_access(exec_context& ec,
                     std::string cmdline,
                     std::vector<std::string>& args)
 {
+#ifdef HAVE_RUST_DEPS
     if (args.size() != 3) {
         return ec.make_error("Expecting port number and API key");
     }
@@ -550,7 +553,8 @@ com_external_access(exec_context& ec,
 
     auto scan_res = scn::scan_int<uint16_t>(args[1]);
     if (!scan_res || !scan_res.value().range().empty()) {
-        return ec.make_error(FMT_STRING("port value is not a number: {}"), args[1]);
+        return ec.make_error(FMT_STRING("port value is not a number: {}"),
+                             args[1]);
     }
     auto port = scan_res->value();
 
@@ -567,6 +571,9 @@ com_external_access(exec_context& ec,
     setenv("LNAV_EXTERNAL_URL", url.c_str(), 1);
 
     return Ok(retval);
+#else
+    return ec.make_error("lnav was compiled without Rust extensions");
+#endif
 }
 
 static readline_context::command_t SCRIPTING_COMMANDS[] = {
diff --git a/src/lnav_commands.cc b/src/lnav_commands.cc
@@ -315,8 +315,8 @@ com_add_src_path(exec_context& ec,
     if (!ec.ec_dry_run) {
         lnav_rs_ext::discover_srcs();
     }
-#endif
     return Ok(retval);
+#endif
 }
 
 static Result<std::string, lnav::console::user_message>
diff --git a/src/third-party/lnav-rs-ext/src/ext_access.rs b/src/third-party/lnav-rs-ext/src/ext_access.rs
@@ -14,6 +14,28 @@ use std::time::Duration;
 static SERVER: LazyLock<Mutex<Option<(JoinHandle<()>, Sender<()>)>>> =
     LazyLock::new(|| None.into());
 
+static LANDING: &'static str = r#"
+<html>
+<head>
+<title>The Logfile Navigator</title>
+</head>
+<body>
+<h1>lnav</h1>
+
+The Logfile Navigator, <b>lnav</b> for short, is a log file viewer for the terminal.
+
+This server provides remote access to an lnav instance.
+
+<ul>
+<li><b>GET</b> /version - Get a JSON object with version information for this instance.</li>
+<li><b>POST</b> /exec - Execute a text/x-lnav-script and return the result.</li>
+</ul>
+
+See <a href="https://lnav.org">lnav.org</a> for more information.
+</body>
+</html>
+"#;
+
 fn do_exec(request: &Request) -> Response {
     let body = try_or_400!(rouille::input::plain_text_body(request));
 
@@ -49,7 +71,7 @@ pub fn start_server(port: u16, api_key: String) -> Result<u16, Box<dyn Error + S
 
         router!(request,
             (GET) (/) => {
-                Response::text("Hello, World!")
+                Response::html(LANDING)
             },
 
             (GET) (/version) => {

Original file line number	Diff line number	Diff line change
`@@ -834,6 +834,7 @@ target_compile_options(diag PRIVATE ${CURSES_CFLAGS})`
`834`	`834`	`add_custom_command(`
`835`	`835`	`OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/target/release/liblnav_rs_ext.a`
`836`	`836`	`COMMAND env CARGO_TARGET_DIR=target cargo build --manifest-path ${CMAKE_CURRENT_SOURCE_DIR}/third-party/lnav-rs-ext/Cargo.toml --package lnav-rs-ext --release`
	`837`	`+ DEPENDS third-party/lnav-rs-ext/src/lib.rs third-party/lnav-rs-ext/src/ext_access.rs`
`837`	`838`	`)`
`838`	`839`	`add_custom_target(`
`839`	`840`	`lnav_rs_ext`
Original file line number	Diff line number	Diff line change
`@@ -474,6 +474,7 @@ com_sh(exec_context& ec, std::string cmdline, std::vector<std::string>& args)`
`474`	`474`	`return Ok(std::string());`
`475`	`475`	`}`
`476`	`476`
	`477`	`+#ifdef HAVE_RUST_DEPS`
`477`	`478`	`namespace lnav_rs_ext {`
`478`	`479`
`479`	`480`	`::rust::String`
`@@ -529,12 +530,14 @@ execute_external_command(::rust::String rs_src, ::rust::String rs_script)`
`529`	`530`	`}`
`530`	`531`
`531`	`532`	`} // namespace lnav_rs_ext`
	`533`	`+#endif`
`532`	`534`
`533`	`535`	`static Result<std::string, lnav::console::user_message>`
`534`	`536`	`com_external_access(exec_context& ec,`
`535`	`537`	`std::string cmdline,`
`536`	`538`	`std::vector<std::string>& args)`
`537`	`539`	`{`
	`540`	`+#ifdef HAVE_RUST_DEPS`
`538`	`541`	`if (args.size() != 3) {`
`539`	`542`	`return ec.make_error("Expecting port number and API key");`
`540`	`543`	`}`
`@@ -550,7 +553,8 @@ com_external_access(exec_context& ec,`
`550`	`553`
`551`	`554`	`auto scan_res = scn::scan_int<uint16_t>(args[1]);`
`552`	`555`	`if (!scan_res \|\| !scan_res.value().range().empty()) {`
`553`		`- return ec.make_error(FMT_STRING("port value is not a number: {}"), args[1]);`
	`556`	`+ return ec.make_error(FMT_STRING("port value is not a number: {}"),`
	`557`	`+ args[1]);`
`554`	`558`	`}`
`555`	`559`	`auto port = scan_res->value();`
`556`	`560`
`@@ -567,6 +571,9 @@ com_external_access(exec_context& ec,`
`567`	`571`	`setenv("LNAV_EXTERNAL_URL", url.c_str(), 1);`
`568`	`572`
`569`	`573`	`return Ok(retval);`
	`574`	`+#else`
	`575`	`+ return ec.make_error("lnav was compiled without Rust extensions");`
	`576`	`+#endif`
`570`	`577`	`}`
`571`	`578`
`572`	`579`	`static readline_context::command_t SCRIPTING_COMMANDS[] = {`
Original file line number	Diff line number	Diff line change
`@@ -315,8 +315,8 @@ com_add_src_path(exec_context& ec,`
`315`	`315`	`if (!ec.ec_dry_run) {`
`316`	`316`	`lnav_rs_ext::discover_srcs();`
`317`	`317`	`}`
`318`		`-#endif`
`319`	`318`	`return Ok(retval);`
	`319`	`+#endif`
`320`	`320`	`}`
`321`	`321`
`322`	`322`	`static Result<std::string, lnav::console::user_message>`