diff options
| author | Aram Drevekenin <aram@poor.dev> | 2025-06-23 19:19:37 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-06-23 19:19:37 +0200 |
| commit | c5ac7968809ddb1033b625562eae22019cccc2f4 (patch) | |
| tree | 932cf07d898dfbcc6ec6a9d4cf5353c06a47accc /zellij-server/src/plugins | |
| parent | feat(ui): add optional tooltip with key hints to the compact bar (#4225) (diff) | |
| download | sl0ppij-c5ac7968809ddb1033b625562eae22019cccc2f4.tar.gz sl0ppij-c5ac7968809ddb1033b625562eae22019cccc2f4.tar.xz sl0ppij-c5ac7968809ddb1033b625562eae22019cccc2f4.zip | |
Feature: web-client/server to share your sessions in the browser (#4242)
* work
* moar work
* notes
* work
* separate to terminal and control channels
* stdin working
* serve html web client initial
* serve static assets loaded with include_dir
* merge
* enable_web_server config parameter
* compile time flag to disable web server capability
* rustfmt
* add license to all xterm.js assets
* mouse working except copy/paste
* helpful comment
* web client improvements
- move script to js file
- add favicon
- add nerd font
- change title
TODO: investigate if font license embedded in otf is sufficient
* get mouse to work properly
* kitty keyboard support initial
* fix wrong type in preload link
* wip axum websocket handlers
- upgrade axum to v0.8.1, enable ws feature
- begin setup of websocket handlers
- tidy up imports
* replace control listener
* handle terminal websocket with axum
* cleanup Cargo.toml
* kitty fixes and bracketed paste
* fix(mouse): pane not found crash
* initial session switching infra
* add `web_client_font` option
* session switching, creation and resurrection working through the session manager
* move session module to zellij-utils and share logic with web-client
* some cleanups
* require restart for enable-web-server
* use session name from router
* write config to disk and watch for config changes
* rename session name to ipc path
* add basic panic handler, make render_to_client exit on channel close
* use while let instead of loop
* handle websocket close
* add mouse motions
* make clipboard work
* add weblink handling and webgl rendering
* add todo
* fix: use session name instead of patch on session switch
* use "default" layout for new sessions
* ui indication for session being shared
* share this session ui
* plugin assets
* Fix process crash on mac with notify watcher.
Use poll watcher instead of recommended as a workaround.
* make url session switching and creation work
* start welcome screen on root url
* scaffold control messages, set font from config
* set dimensions on session start
* bring back session name from url
* send bytes on terminal websocket instead of json
- create web client os input and id before websocket connection
* draft ui
* work
* refactor ui
* remove otf font, remove margins to avoid scrollbar
* version query endpoint for server status
* web session info query endpoint
* refactor: move stuff around
* add web client info to session metadata
* make tests pass
* populate real data in session list
* remove unnecessary endpoint
* add web_client node to config, add font option
* remove web_client_font
* allow disabling the web session through the config - WIP
* formalize sharing/not-sharing configuration
* fix tests
* allow shutting down web server
* display error when web clients are forbidden to attach
* only show sessions that allow web clients if this is a web client
* style(fmt): rustfmt
* fix: query web server from Zellij rather than from each plugin
* remove log spam
* handle some error paths better in the web client
* allow controlling the web server through the cli
* allow configuring the web server's ip/port
* fix tests and format code
* use direct WebServerStatus event instead of piggy-backing on SessionInfo
* plugin revamp initial
* make plugin responsive
* adjust plugin title
* refactor: share plugin
* refactor: share plugin
* add cors middleware
* some fixes for running without a compiled web server capability
* display error when starting the share plugin without web server support
* clarify config
* add pipelines to compile zellij without web support
* display error when unable to start web server
* only query web server when share plugin is running
* refactor(web-client): connection table
* give zellij_server_listener access to the control channel
* fixes and clarifications
* refactor: consolidate generate_unique_session_name
* give proper error when trying to attach to a forbidden session
* change browser URL when switching sessions
* add keyboard shortcut
* enforce https when bound to non-loopback ip
* initial authentication token implementation
* background color from theme
* initial web client theme config
* basic token generation ui
* refactor set config message creation
* also set body background
* allow editing scrollback for plugins too
* set scrollback to 0
* properly parse colors in config
* generate token from plugin
* nice login modals
* initial token management screen
* implement token authentication
* refactor(share): token management screen
* style(fmt): rustfmt
* fix(plugin): some minor bugs
* refactor(share): main screen
* refactor(share): token screen
* refactor(share): main
* refactor(share): ui components
* fix(responsiveness): properly send usage_width to the render function
* fix cli commands and add some verbosity
* add support for settings ansi and selection colors
* add cursor and cursor accent
* basic web client tests
* fix tests
* refactor: web client
* use session tokens for authentication
* improve modals
* move shutdown to ipc
* refactor: ipc logic
* serialize theme config for web client
* update tests
* refactor: move some stuff around to prepare for config hot reload
* config live reloading for the web clients
* change remember-me UI wording
* improve xterm.js link handling
* make sure terminal is focused on mousemove
* remove deprecated sharing indication from compact-bar
* gate deps and functionality behind the web_server_compatibility feature
* feat(build): add --no-web flag in all the places
* fix some other build flows
* add new assets
* update CI for no-web (untested)
* make more dependencies optional
* update axum-extra
* add web client configuration options
* gracefully close connections on server exit
* tests for graceful connection closing
* handle client-side reconnect when server is down
* fix: make sure ipc bus folder exists before starting
* add commands to manage login tokens from the cli
* style(fmt): rustfmt
* some cleanups
* fix(ux): allow alt-right-click on the web client without opening the context menu
* fix: prevent attaching to welcome screen
* fix: reload config issues
* fix long socket path on macos
* normalize config conversion and fix color gap in browser
* revoke session_token cookie if it is not valid
* fix: visual bug with multiple clients in extremely small screen sizes
* fix: only include rusqlite for the web server capability builds
* update e2e snapshots
* refactor(web): client side js
* some cleanups
* moar cleanups
* fix(tests): wait for server instead of using a fixed timeout
* debug CI
* fix(tests): use spawn_blocking for running the test web server
* fix(tests): wait for http rather than tcp port
* fix(tests): properly pass config path - hopefully this is the issue...
* success! bring back the rest of the tests
* attempt to fix the macos CI issue
* docs(changelog): add PR
---------
Co-authored-by: Thomas Linford <linford.t@gmail.com>
Diffstat (limited to 'zellij-server/src/plugins')
7 files changed, 255 insertions, 11 deletions
diff --git a/zellij-server/src/plugins/mod.rs b/zellij-server/src/plugins/mod.rs index ab853614..48620a99 100644 --- a/zellij-server/src/plugins/mod.rs +++ b/zellij-server/src/plugins/mod.rs @@ -27,6 +27,7 @@ use zellij_utils::{ data::{ ClientInfo, Event, EventType, FloatingPaneCoordinates, InputMode, MessageToPlugin, PermissionStatus, PermissionType, PipeMessage, PipeSource, PluginCapabilities, + WebServerStatus, }, errors::{prelude::*, ContextType, PluginContext}, input::{ @@ -77,9 +78,9 @@ pub enum PluginInstruction { Option<TerminalAction>, Option<TiledPaneLayout>, Vec<FloatingPaneLayout>, - usize, // tab_index - bool, // should change focus to new tab - ClientId, + usize, // tab_index + bool, // should change focus to new tab + (ClientId, bool), // bool -> is_web_client ), ApplyCachedEvents { plugin_ids: Vec<PluginId>, @@ -162,6 +163,8 @@ pub enum PluginInstruction { WatchFilesystem, ListClientsToPlugin(SessionLayoutMetadata, PluginId, ClientId), ChangePluginHostDir(PathBuf, PluginId, ClientId), + WebServerStarted(String), // String -> the base url of the web server + FailedToStartWebServer(String), Exit, } @@ -209,6 +212,8 @@ impl From<&PluginInstruction> for PluginContext { }, PluginInstruction::ListClientsToPlugin(..) => PluginContext::ListClientsToPlugin, PluginInstruction::ChangePluginHostDir(..) => PluginContext::ChangePluginHostDir, + PluginInstruction::WebServerStarted(..) => PluginContext::WebServerStarted, + PluginInstruction::FailedToStartWebServer(..) => PluginContext::FailedToStartWebServer, } } } @@ -424,7 +429,7 @@ pub(crate) fn plugin_thread_main( mut floating_panes_layout, tab_index, should_change_focus_to_new_tab, - client_id, + (client_id, is_web_client), ) => { // prefer connected clients so as to avoid opening plugins in the background for // CLI clients unless no-one else is connected @@ -496,7 +501,7 @@ pub(crate) fn plugin_thread_main( tab_index, plugin_ids, should_change_focus_to_new_tab, - client_id, + (client_id, is_web_client), ))); }, PluginInstruction::ApplyCachedEvents { @@ -915,6 +920,22 @@ pub(crate) fn plugin_thread_main( .change_plugin_host_dir(new_host_folder, plugin_id, client_id) .non_fatal(); }, + PluginInstruction::WebServerStarted(base_url) => { + let updates = vec![( + None, + None, + Event::WebServerStatus(WebServerStatus::Online(base_url)), + )]; + wasm_bridge + .update_plugins(updates, shutdown_send.clone()) + .non_fatal(); + }, + PluginInstruction::FailedToStartWebServer(error) => { + let updates = vec![(None, None, Event::FailedToStartWebServer(error))]; + wasm_bridge + .update_plugins(updates, shutdown_send.clone()) + .non_fatal(); + }, PluginInstruction::Exit => { break; }, diff --git a/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tab_plugin_command.snap b/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tab_plugin_command.snap index 0465686b..fb471bf5 100644 --- a/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tab_plugin_command.snap +++ b/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tab_plugin_command.snap @@ -1,6 +1,5 @@ --- source: zellij-server/src/plugins/./unit/plugin_tests.rs -assertion_line: 1373 expression: "format!(\"{:#?}\", new_tab_event)" --- Some( @@ -15,6 +14,9 @@ Some( [], ), true, - 1, + ( + 1, + false, + ), ), ) diff --git a/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tabs_with_layout_plugin_command-2.snap b/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tabs_with_layout_plugin_command-2.snap index e35e94bb..56b2221f 100644 --- a/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tabs_with_layout_plugin_command-2.snap +++ b/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tabs_with_layout_plugin_command-2.snap @@ -1,6 +1,5 @@ --- source: zellij-server/src/plugins/./unit/plugin_tests.rs -assertion_line: 1301 expression: "format!(\"{:#?}\", second_new_tab_event)" --- Some( @@ -65,6 +64,9 @@ Some( [], ), false, - 1, + ( + 1, + false, + ), ), ) diff --git a/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tabs_with_layout_plugin_command.snap b/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tabs_with_layout_plugin_command.snap index fbc68b9e..75a2d011 100644 --- a/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tabs_with_layout_plugin_command.snap +++ b/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__new_tabs_with_layout_plugin_command.snap @@ -1,6 +1,5 @@ --- source: zellij-server/src/plugins/./unit/plugin_tests.rs -assertion_line: 1300 expression: "format!(\"{:#?}\", first_new_tab_event)" --- Some( @@ -65,6 +64,9 @@ Some( [], ), true, - 1, + ( + 1, + false, + ), ), ) diff --git a/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__switch_to_mode_plugin_command.snap b/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__switch_to_mode_plugin_command.snap index 44226784..10b3a900 100644 --- a/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__switch_to_mode_plugin_command.snap +++ b/zellij-server/src/plugins/unit/snapshots/zellij_server__plugins__plugin_tests__switch_to_mode_plugin_command.snap @@ -317,7 +317,13 @@ Some( ), editor: None, shell: None, + web_clients_allowed: None, + web_sharing: None, currently_marking_pane_group: None, + is_web_client: None, + web_server_ip: None, + web_server_port: None, + web_server_capability: None, }, 1, ), diff --git a/zellij-server/src/plugins/wasm_bridge.rs b/zellij-server/src/plugins/wasm_bridge.rs index 4562f5a5..fd4b0d36 100644 --- a/zellij-server/src/plugins/wasm_bridge.rs +++ b/zellij-server/src/plugins/wasm_bridge.rs @@ -1588,6 +1588,7 @@ fn check_event_permission( | Event::FailedToWriteConfigToDisk(..) | Event::CommandPaneReRun(..) | Event::InputReceived => PermissionType::ReadApplicationState, + Event::WebServerStatus(..) => PermissionType::StartWebServer, _ => return (PermissionStatus::Granted, None), }; diff --git a/zellij-server/src/plugins/zellij_exports.rs b/zellij-server/src/plugins/zellij_exports.rs index ffc3fce9..b928b224 100644 --- a/zellij-server/src/plugins/zellij_exports.rs +++ b/zellij-server/src/plugins/zellij_exports.rs @@ -25,6 +25,12 @@ use zellij_utils::data::{ }; use zellij_utils::input::permission::PermissionCache; use zellij_utils::ipc::{ClientToServerMsg, IpcSenderWithContext}; +#[cfg(feature = "web_server_capability")] +use zellij_utils::web_authentication_tokens::{ + create_token, list_tokens, rename_token, revoke_all_tokens, revoke_token, +}; +#[cfg(feature = "web_server_capability")] +use zellij_utils::web_server_commands::shutdown_all_webserver_instances; use crate::{panes::PaneId, screen::ScreenInstruction}; @@ -47,6 +53,12 @@ use zellij_utils::{ }, }; +#[cfg(feature = "web_server_capability")] +use zellij_utils::plugin_api::plugin_command::{ + CreateTokenResponse, ListTokensResponse, RenameWebTokenResponse, RevokeAllWebTokensResponse, + RevokeTokenResponse, +}; + macro_rules! apply_action { ($action:ident, $error_message:ident, $env: ident) => { if let Err(e) = route_action( @@ -456,6 +468,29 @@ fn host_run_plugin_command(mut caller: Caller<'_, PluginEnv>) { PluginCommand::EmbedMultiplePanes(pane_ids) => { embed_multiple_panes(env, pane_ids.into_iter().map(|p| p.into()).collect()) }, + PluginCommand::StartWebServer => start_web_server(env), + PluginCommand::StopWebServer => stop_web_server(env), + PluginCommand::QueryWebServerStatus => query_web_server_status(env), + PluginCommand::ShareCurrentSession => share_current_session(env), + PluginCommand::StopSharingCurrentSession => stop_sharing_current_session(env), + PluginCommand::SetSelfMouseSelectionSupport(selection_support) => { + set_self_mouse_selection_support(env, selection_support); + }, + PluginCommand::GenerateWebLoginToken(token_label) => { + generate_web_login_token(env, token_label); + }, + PluginCommand::RevokeWebLoginToken(label) => { + revoke_web_login_token(env, label); + }, + PluginCommand::ListWebLoginTokens => { + list_web_login_tokens(env); + }, + PluginCommand::RevokeAllWebLoginTokens => { + revoke_all_web_login_tokens(env); + }, + PluginCommand::RenameWebLoginToken(old_name, new_name) => { + rename_web_login_token(env, old_name, new_name); + }, PluginCommand::InterceptKeyPresses => intercept_key_presses(&mut env), PluginCommand::ClearKeyPressesIntercepts => { clear_key_presses_intercepts(&mut env) @@ -2179,6 +2214,37 @@ fn load_new_plugin( } } +fn start_web_server(env: &PluginEnv) { + let _ = env + .senders + .send_to_server(ServerInstruction::StartWebServer(env.client_id)); +} + +fn stop_web_server(_env: &PluginEnv) { + #[cfg(feature = "web_server_capability")] + let _ = shutdown_all_webserver_instances(); + #[cfg(not(feature = "web_server_capability"))] + log::error!("This instance of Zellij was compiled without web server capabilities"); +} + +fn query_web_server_status(env: &PluginEnv) { + let _ = env + .senders + .send_to_background_jobs(BackgroundJob::QueryZellijWebServerStatus); +} + +fn share_current_session(env: &PluginEnv) { + let _ = env + .senders + .send_to_server(ServerInstruction::ShareCurrentSession(env.client_id)); +} + +fn stop_sharing_current_session(env: &PluginEnv) { + let _ = env + .senders + .send_to_server(ServerInstruction::StopSharingCurrentSession(env.client_id)); +} + fn group_and_ungroup_panes( env: &PluginEnv, panes_to_group: Vec<PaneId>, @@ -2238,6 +2304,140 @@ fn embed_multiple_panes(env: &PluginEnv, pane_ids: Vec<PaneId>) { )); } +#[cfg(feature = "web_server_capability")] +fn generate_web_login_token(env: &PluginEnv, token_label: Option<String>) { + let serialized = match create_token(token_label) { + Ok((token, token_label)) => CreateTokenResponse { + token: Some(token), + token_label: Some(token_label), + error: None, + }, + Err(e) => CreateTokenResponse { + token: None, + token_label: None, + error: Some(e.to_string()), + }, + }; + let _ = wasi_write_object(env, &serialized.encode_to_vec()); +} + +#[cfg(not(feature = "web_server_capability"))] +fn generate_web_login_token(env: &PluginEnv, _token_label: Option<String>) { + log::error!("This version of Zellij was compiled without the web server capabilities!"); + let empty_vec: Vec<&str> = vec![]; + let _ = wasi_write_object(env, &empty_vec); +} + +#[cfg(feature = "web_server_capability")] +fn revoke_web_login_token(env: &PluginEnv, token_label: String) { + let serialized = match revoke_token(&token_label) { + Ok(true) => RevokeTokenResponse { + successfully_revoked: true, + error: None, + }, + Ok(false) => RevokeTokenResponse { + successfully_revoked: false, + error: Some(format!("Token with label {} not found", token_label)), + }, + Err(e) => RevokeTokenResponse { + successfully_revoked: false, + error: Some(e.to_string()), + }, + }; + let _ = wasi_write_object(env, &serialized.encode_to_vec()); +} + +#[cfg(not(feature = "web_server_capability"))] +fn revoke_web_login_token(env: &PluginEnv, _token_label: String) { + log::error!("This version of Zellij was compiled without the web server capabilities!"); + let empty_vec: Vec<&str> = vec![]; + let _ = wasi_write_object(env, &empty_vec); +} + +#[cfg(feature = "web_server_capability")] +fn revoke_all_web_login_tokens(env: &PluginEnv) { + let serialized = match revoke_all_tokens() { + Ok(_) => RevokeAllWebTokensResponse { + successfully_revoked: true, + error: None, + }, + Err(e) => RevokeAllWebTokensResponse { + successfully_revoked: false, + error: Some(e.to_string()), + }, + }; + let _ = wasi_write_object(env, &serialized.encode_to_vec()); +} + +#[cfg(not(feature = "web_server_capability"))] +fn revoke_all_web_login_tokens(env: &PluginEnv) { + log::error!("This version of Zellij was compiled without the web server capabilities!"); + let empty_vec: Vec<&str> = vec![]; + let _ = wasi_write_object(env, &empty_vec); +} + +#[cfg(feature = "web_server_capability")] +fn rename_web_login_token(env: &PluginEnv, old_name: String, new_name: String) { + let serialized = match rename_token(&old_name, &new_name) { + Ok(_) => RenameWebTokenResponse { + successfully_renamed: true, + error: None, + }, + Err(e) => RenameWebTokenResponse { + successfully_renamed: false, + error: Some(e.to_string()), + }, + }; + let _ = wasi_write_object(env, &serialized.encode_to_vec()); +} + +#[cfg(not(feature = "web_server_capability"))] +fn rename_web_login_token(env: &PluginEnv, _old_name: String, _new_name: String) { + log::error!("This version of Zellij was compiled without the web server capabilities!"); + let empty_vec: Vec<&str> = vec![]; + let _ = wasi_write_object(env, &empty_vec); +} + +#[cfg(feature = "web_server_capability")] +fn list_web_login_tokens(env: &PluginEnv) { + let serialized = match list_tokens() { + Ok(token_list) => ListTokensResponse { + tokens: token_list.iter().map(|t| t.name.clone()).collect(), + creation_times: token_list.iter().map(|t| t.created_at.clone()).collect(), + error: None, + }, + Err(e) => ListTokensResponse { + tokens: vec![], + creation_times: vec![], + error: Some(e.to_string()), + }, + }; + let _ = wasi_write_object(env, &serialized.encode_to_vec()); +} + +#[cfg(not(feature = "web_server_capability"))] +fn list_web_login_tokens(env: &PluginEnv) { + log::error!("This version of Zellij was compiled without the web server capabilities!"); + let empty_vec: Vec<&str> = vec![]; + let _ = wasi_write_object(env, &empty_vec); +} + +fn set_self_mouse_selection_support(env: &PluginEnv, selection_support: bool) { + env.senders + .send_to_screen(ScreenInstruction::SetMouseSelectionSupport( + PaneId::Plugin(env.plugin_id), + selection_support, + )) + .with_context(|| { + format!( + "failed to set plugin {} selectable from plugin {}", + selection_support, + env.name() + ) + }) + .non_fatal(); +} + fn intercept_key_presses(env: &mut PluginEnv) { env.intercepting_key_presses = true; let _ = env @@ -2433,6 +2633,16 @@ fn check_command_permission( PermissionType::Reconfigure }, PluginCommand::ChangeHostFolder(..) => PermissionType::FullHdAccess, + PluginCommand::ShareCurrentSession + | PluginCommand::StopSharingCurrentSession + | PluginCommand::StopWebServer + | PluginCommand::QueryWebServerStatus + | PluginCommand::GenerateWebLoginToken(..) + | PluginCommand::RevokeWebLoginToken(..) + | PluginCommand::RevokeAllWebLoginTokens + | PluginCommand::RenameWebLoginToken(..) + | PluginCommand::ListWebLoginTokens + | PluginCommand::StartWebServer => PermissionType::StartWebServer, PluginCommand::InterceptKeyPresses | PluginCommand::ClearKeyPressesIntercepts => { PermissionType::InterceptInput }, |
