aboutsummaryrefslogtreecommitdiffstats
path: root/default-plugins/share/src/main_screen.rs
diff options
context:
space:
mode:
authorAram Drevekenin <aram@poor.dev>2025-06-23 19:19:37 +0200
committerGitHub <noreply@github.com>2025-06-23 19:19:37 +0200
commitc5ac7968809ddb1033b625562eae22019cccc2f4 (patch)
tree932cf07d898dfbcc6ec6a9d4cf5353c06a47accc /default-plugins/share/src/main_screen.rs
parentfeat(ui): add optional tooltip with key hints to the compact bar (#4225) (diff)
downloadsl0ppij-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 'default-plugins/share/src/main_screen.rs')
-rw-r--r--default-plugins/share/src/main_screen.rs301
1 files changed, 301 insertions, 0 deletions
diff --git a/default-plugins/share/src/main_screen.rs b/default-plugins/share/src/main_screen.rs
new file mode 100644
index 00000000..b1222592
--- /dev/null
+++ b/default-plugins/share/src/main_screen.rs
@@ -0,0 +1,301 @@
+use super::CoordinatesInLine;
+use crate::ui_components::{
+ hovering_on_line, render_text_with_underline, CurrentSessionSection, Usage,
+ WebServerStatusSection,
+};
+use zellij_tile::prelude::*;
+
+use std::collections::HashMap;
+use url::Url;
+
+pub struct MainScreenState {
+ pub currently_hovering_over_link: bool,
+ pub currently_hovering_over_unencrypted: bool,
+ pub clickable_urls: HashMap<CoordinatesInLine, String>,
+}
+
+pub struct MainScreen<'a> {
+ token_list_is_empty: bool,
+ web_server_started: bool,
+ web_server_error: &'a Option<String>,
+ web_server_different_version_error: &'a Option<String>,
+ web_server_base_url: &'a String,
+ web_server_ip: Option<std::net::IpAddr>,
+ web_server_port: Option<u16>,
+ session_name: &'a Option<String>,
+ web_sharing: WebSharing,
+ hover_coordinates: Option<(usize, usize)>,
+ info: &'a Option<String>,
+ link_executable: &'a Option<&'a str>,
+}
+
+impl<'a> MainScreen<'a> {
+ const TITLE_TEXT: &'static str = "Share Session Locally in the Browser";
+ const WARNING_TEXT: &'static str =
+ "[*] Connection unencrypted. Consider using an SSL certificate.";
+ const MORE_INFO_TEXT: &'static str = "More info: ";
+ const SSL_URL: &'static str = "https://zellij.dev/documentation/web-server-ssl";
+ const HELP_TEXT_WITH_CLICK: &'static str = "Help: Click or Shift-Click to open in browser";
+ const HELP_TEXT_SHIFT_ONLY: &'static str = "Help: Shift-Click to open in browser";
+ pub fn new(
+ token_list_is_empty: bool,
+ web_server_started: bool,
+ web_server_error: &'a Option<String>,
+ web_server_different_version_error: &'a Option<String>,
+ web_server_base_url: &'a String,
+ web_server_ip: Option<std::net::IpAddr>,
+ web_server_port: Option<u16>,
+ session_name: &'a Option<String>,
+ web_sharing: WebSharing,
+ hover_coordinates: Option<(usize, usize)>,
+ info: &'a Option<String>,
+ link_executable: &'a Option<&'a str>,
+ ) -> Self {
+ Self {
+ token_list_is_empty,
+ web_server_started,
+ web_server_error,
+ web_server_different_version_error,
+ web_server_base_url,
+ web_server_ip,
+ web_server_port,
+ session_name,
+ web_sharing,
+ hover_coordinates,
+ info,
+ link_executable,
+ }
+ }
+
+ pub fn render(self, rows: usize, cols: usize) -> MainScreenState {
+ let mut state = MainScreenState {
+ currently_hovering_over_link: false,
+ currently_hovering_over_unencrypted: false,
+ clickable_urls: HashMap::new(),
+ };
+
+ let layout = self.calculate_layout(rows, cols);
+ self.render_content(&layout, &mut state);
+
+ state
+ }
+
+ fn calculate_layout(&self, rows: usize, cols: usize) -> Layout {
+ let usage = Usage::new(!self.token_list_is_empty);
+ let web_server_status_section = WebServerStatusSection::new(
+ self.web_server_started,
+ self.web_server_error.clone(),
+ self.web_server_different_version_error.clone(),
+ self.web_server_base_url.clone(),
+ self.connection_is_unencrypted(),
+ );
+ let current_session_section = CurrentSessionSection::new(
+ self.web_server_started,
+ self.web_server_ip,
+ self.web_server_port,
+ self.session_name.clone(),
+ self.web_sharing,
+ self.connection_is_unencrypted(),
+ );
+
+ let title_width = Self::TITLE_TEXT.chars().count();
+
+ let (web_server_width, web_server_height) =
+ web_server_status_section.web_server_status_width_and_height();
+ let (current_session_width, current_session_height) =
+ current_session_section.current_session_status_width_and_height();
+ let (usage_width, usage_height) = usage.usage_width_and_height(cols);
+
+ let mut max_width = title_width
+ .max(web_server_width)
+ .max(current_session_width)
+ .max(usage_width);
+
+ let mut total_height =
+ 2 + web_server_height + 1 + current_session_height + 1 + usage_height;
+
+ if self.connection_is_unencrypted() {
+ let warning_width = self.unencrypted_warning_width();
+ max_width = max_width.max(warning_width);
+ total_height += 3;
+ }
+
+ Layout {
+ base_x: cols.saturating_sub(max_width) / 2,
+ base_y: rows.saturating_sub(total_height) / 2,
+ title_text: Self::TITLE_TEXT,
+ web_server_height,
+ usage_height,
+ usage_width,
+ }
+ }
+
+ fn render_content(&self, layout: &Layout, state: &mut MainScreenState) {
+ let mut current_y = layout.base_y;
+
+ self.render_title(layout, current_y);
+ current_y += 2;
+
+ current_y = self.render_web_server_section(layout, current_y, state);
+ current_y = self.render_current_session_section(layout, current_y, state);
+ current_y = self.render_usage_section(layout, current_y);
+ current_y = self.render_warnings_and_help(layout, current_y, state);
+
+ self.render_info(layout, current_y);
+ }
+
+ fn render_title(&self, layout: &Layout, y: usize) {
+ let title = Text::new(layout.title_text).color_range(2, ..);
+ print_text_with_coordinates(title, layout.base_x, y, None, None);
+ }
+
+ fn render_web_server_section(
+ &self,
+ layout: &Layout,
+ y: usize,
+ state: &mut MainScreenState,
+ ) -> usize {
+ let mut web_server_status_section = WebServerStatusSection::new(
+ self.web_server_started,
+ self.web_server_error.clone(),
+ self.web_server_different_version_error.clone(),
+ self.web_server_base_url.clone(),
+ self.connection_is_unencrypted(),
+ );
+
+ web_server_status_section.render_web_server_status(
+ layout.base_x,
+ y,
+ self.hover_coordinates,
+ );
+
+ state.currently_hovering_over_link |=
+ web_server_status_section.currently_hovering_over_link;
+ state.currently_hovering_over_unencrypted |=
+ web_server_status_section.currently_hovering_over_unencrypted;
+
+ for (coordinates, url) in web_server_status_section.clickable_urls {
+ state.clickable_urls.insert(coordinates, url);
+ }
+
+ y + layout.web_server_height + 1
+ }
+
+ fn render_current_session_section(
+ &self,
+ layout: &Layout,
+ y: usize,
+ state: &mut MainScreenState,
+ ) -> usize {
+ let mut current_session_section = CurrentSessionSection::new(
+ self.web_server_started,
+ self.web_server_ip,
+ self.web_server_port,
+ self.session_name.clone(),
+ self.web_sharing,
+ self.connection_is_unencrypted(),
+ );
+
+ current_session_section.render_current_session_status(
+ layout.base_x,
+ y,
+ self.hover_coordinates,
+ );
+
+ state.currently_hovering_over_link |= current_session_section.currently_hovering_over_link;
+
+ for (coordinates, url) in current_session_section.clickable_urls {
+ state.clickable_urls.insert(coordinates, url);
+ }
+
+ y + layout.web_server_height + 1
+ }
+
+ fn render_usage_section(&self, layout: &Layout, y: usize) -> usize {
+ let usage = Usage::new(!self.token_list_is_empty);
+ usage.render_usage(layout.base_x, y, layout.usage_width);
+ y + layout.usage_height + 1
+ }
+
+ fn render_warnings_and_help(
+ &self,
+ layout: &Layout,
+ mut y: usize,
+ state: &mut MainScreenState,
+ ) -> usize {
+ if self.connection_is_unencrypted() && self.web_server_started {
+ self.render_unencrypted_warning(layout.base_x, y, state);
+ y += 3;
+ }
+
+ if state.currently_hovering_over_link {
+ self.render_link_help(layout.base_x, y);
+ y += 3;
+ }
+
+ y
+ }
+
+ fn render_info(&self, layout: &Layout, y: usize) {
+ if let Some(info) = self.info {
+ let info_text = Text::new(info).color_range(1, ..);
+ print_text_with_coordinates(info_text, layout.base_x, y, None, None);
+ }
+ }
+
+ fn unencrypted_warning_width(&self) -> usize {
+ let more_info_line = format!("{}{}", Self::MORE_INFO_TEXT, Self::SSL_URL);
+ std::cmp::max(
+ Self::WARNING_TEXT.chars().count(),
+ more_info_line.chars().count(),
+ )
+ }
+
+ fn render_unencrypted_warning(&self, x: usize, y: usize, state: &mut MainScreenState) {
+ let warning_text = Text::new(Self::WARNING_TEXT).color_range(1, ..3);
+ let more_info_line = Text::new(format!("{}{}", Self::MORE_INFO_TEXT, Self::SSL_URL));
+
+ let url_x = x + Self::MORE_INFO_TEXT.chars().count();
+ let url_y = y + 1;
+ let url_width = Self::SSL_URL.chars().count();
+
+ state.clickable_urls.insert(
+ CoordinatesInLine::new(url_x, url_y, url_width),
+ Self::SSL_URL.to_owned(),
+ );
+
+ print_text_with_coordinates(warning_text, x, y, None, None);
+ print_text_with_coordinates(more_info_line, x, y + 1, None, None);
+
+ if hovering_on_line(url_x, url_y, url_width, self.hover_coordinates) {
+ state.currently_hovering_over_link = true;
+ render_text_with_underline(url_x, url_y, Self::SSL_URL);
+ }
+ }
+
+ fn render_link_help(&self, x: usize, y: usize) {
+ let help_text = if self.link_executable.is_some() {
+ Text::new(Self::HELP_TEXT_WITH_CLICK)
+ .color_range(3, 6..=10)
+ .color_range(3, 15..=25)
+ } else {
+ Text::new(Self::HELP_TEXT_SHIFT_ONLY).color_range(3, 6..=16)
+ };
+ print_text_with_coordinates(help_text, x, y, None, None);
+ }
+ pub fn connection_is_unencrypted(&self) -> bool {
+ Url::parse(&self.web_server_base_url)
+ .ok()
+ .map(|b| b.scheme() == "http")
+ .unwrap_or(false)
+ }
+}
+
+struct Layout<'a> {
+ base_x: usize,
+ base_y: usize,
+ title_text: &'a str,
+ web_server_height: usize,
+ usage_height: usize,
+ usage_width: usize,
+}