use crate::common::ipc::{ ClientToServerMsg, IpcReceiverWithContext, IpcSenderWithContext, ServerToClientMsg, }; use crate::errors::ErrorContext; use crate::panes::PositionAndSize; use crate::utils::shared::default_palette; use interprocess::local_socket::LocalSocketStream; use nix::fcntl::{fcntl, FcntlArg, OFlag}; use nix::pty::{forkpty, Winsize}; use nix::sys::signal::{kill, Signal}; use nix::sys::termios; use nix::sys::wait::waitpid; use nix::unistd::{self, ForkResult, Pid}; use signal_hook::{consts::signal::*, iterator::Signals}; use std::io::prelude::*; use std::os::unix::{fs::PermissionsExt, io::RawFd}; use std::path::{Path, PathBuf}; use std::process::{Child, Command}; use std::sync::{Arc, Mutex}; use std::{env, fs, io}; use zellij_tile::data::Palette; const UNIX_PERMISSIONS: u32 = 0o700; pub fn set_permissions(path: &Path) -> io::Result<()> { let mut permissions = fs::metadata(path)?.permissions(); permissions.set_mode(UNIX_PERMISSIONS); fs::set_permissions(path, permissions) } fn into_raw_mode(pid: RawFd) { let mut tio = termios::tcgetattr(pid).expect("could not get terminal attribute"); termios::cfmakeraw(&mut tio); match termios::tcsetattr(pid, termios::SetArg::TCSANOW, &tio) { Ok(_) => {} Err(e) => panic!("error {:?}", e), }; } fn unset_raw_mode(pid: RawFd, orig_termios: termios::Termios) { match termios::tcsetattr(pid, termios::SetArg::TCSANOW, &orig_termios) { Ok(_) => {} Err(e) => panic!("error {:?}", e), }; } pub fn get_terminal_size_using_fd(fd: RawFd) -> PositionAndSize { // TODO: do this with the nix ioctl use libc::ioctl; use libc::TIOCGWINSZ; let mut winsize = Winsize { ws_row: 0, ws_col: 0, ws_xpixel: 0, ws_ypixel: 0, }; unsafe { ioctl(fd, TIOCGWINSZ, &mut winsize) }; PositionAndSize::from(winsize) } pub fn set_terminal_size_using_fd(fd: RawFd, columns: u16, rows: u16) { // TODO: do this with the nix ioctl use libc::ioctl; use libc::TIOCSWINSZ; let winsize = Winsize { ws_col: columns, ws_row: rows, ws_xpixel: 0, ws_ypixel: 0, }; unsafe { ioctl(fd, TIOCSWINSZ, &winsize) }; } /// Handle some signals for the child process. This will loop until the child /// process exits. fn handle_command_exit(mut child: Child) { // register the SIGINT signal (TODO handle more signals) let mut signals = ::signal_hook::iterator::Signals::new(&[SIGINT]).unwrap(); 'handle_exit: loop { // test whether the child process has exited match child.try_wait() { Ok(Some(_status)) => { // if the child process has exited, break outside of the loop // and exit this function // TODO: handle errors? break 'handle_exit; } Ok(None) => { ::std::thread::sleep(::std::time::Duration::from_millis(100)); } Err(e) => panic!("error attempting to wait: {}", e), } for signal in signals.pending() { if let SIGINT = signal { child.kill().unwrap(); child.wait().unwrap(); break 'handle_exit; } } } } /// Spawns a new terminal from the parent terminal with [`termios`](termios::Termios) /// `orig_termios`. /// /// If a `file_to_open` is given, the text editor specified by environment variable `EDITOR` /// (or `VISUAL`, if `EDITOR` is not set) will be started in the new terminal, with the given /// file open. If no file is given, the shell specified by environment variable `SHELL` will /// be started in the new terminal. /// /// # Panics /// /// This function will panic if both the `EDITOR` and `VISUAL` environment variables are not /// set. // FIXME this should probably be split into different functions, or at least have less levels // of indentation in some way fn spawn_terminal(file_to_open: Option, orig_termios: termios::Termios) -> (RawFd, RawFd) { let (pid_primary, pid_secondary): (RawFd, RawFd) = { match forkpty(None, Some(&orig_termios)) { Ok(fork_pty_res) => { let pid_primary = fork_pty_res.master; let pid_secondary = match fork_pty_res.fork_result { ForkResult::Parent { child } => { // fcntl(pid_primary, FcntlArg::F_SETFL(OFlag::empty())).expect("could not fcntl"); fcntl(pid_primary, FcntlArg::F_SETFL(OFlag::O_NONBLOCK)) .expect("could not fcntl"); child } ForkResult::Child => match file_to_open { Some(file_to_open) => { if env::var("EDITOR").is_err() && env::var("VISUAL").is_err() { panic!("Can't edit files if an editor is not defined. To fix: define the EDITOR or VISUAL environment variables with the path to your editor (eg. /usr/bin/vim)"); } let editor = env::var("EDITOR").unwrap_or_else(|_| env::var("VISUAL").unwrap()); let child = Command::new(editor) .args(&[file_to_open]) .spawn() .expect("failed to spawn"); handle_command_exit(child); ::std::process::exit(0); } None => { let child = Command::new(env::var("SHELL").unwrap()) .spawn() .expect("failed to spawn"); handle_command_exit(child); ::std::process::exit(0); } }, }; (pid_primary, pid_secondary.as_raw()) } Err(e) => { panic!("failed to fork {:?}", e); } } }; (pid_primary, pid_secondary) } #[derive(Clone)] pub struct ServerOsInputOutput { orig_termios: Arc>, receive_instructions_from_client: Option>>>, send_instructions_to_client: Arc>>>, } /// The `ServerOsApi` trait represents an abstract interface to the features of an operating system that /// Zellij server requires. pub trait ServerOsApi: Send + Sync { /// Sets the size of the terminal associated to file descriptor `fd`. fn set_terminal_size_using_fd(&mut self, fd: RawFd, cols: u16, rows: u16); /// Spawn a new terminal, with an optional file to open in a terminal program. fn spawn_terminal(&mut self, file_to_open: Option) -> (RawFd, RawFd); /// Read bytes from the standard output of the virtual terminal referred to by `fd`. fn read_from_tty_stdout(&mut self, fd: RawFd, buf: &mut [u8]) -> Result; /// Write bytes to the standard input of the virtual terminal referred to by `fd`. fn write_to_tty_stdin(&mut self, fd: RawFd, buf: &mut [u8]) -> Result; /// Wait until all output written to the object referred to by `fd` has been transmitted. fn tcdrain(&mut self, fd: RawFd) -> Result<(), nix::Error>; /// Terminate the process with process ID `pid`. // FIXME `RawFd` is semantically the wrong type here. It should either be a raw libc::pid_t, // or a nix::unistd::Pid. See `man kill.3`, nix::sys::signal::kill (both take an argument // called `pid` and of type `pid_t`, and not `fd`) fn kill(&mut self, pid: RawFd) -> Result<(), nix::Error>; /// Returns a [`Box`] pointer to this [`ServerOsApi`] struct. fn box_clone(&self) -> Box; /// Receives a message on server-side IPC channel fn recv_from_client(&self) -> (ClientToServerMsg, ErrorContext); /// Sends a message to client fn send_to_client(&self, msg: ServerToClientMsg); /// Adds a sender to client fn add_client_sender(&mut self); /// Update the receiver socket for the client fn update_receiver(&mut self, stream: LocalSocketStream); fn load_palette(&self) -> Palette; } impl ServerOsApi for ServerOsInputOutput { fn set_terminal_size_using_fd(&mut self, fd: RawFd, cols: u16, rows: u16) { set_terminal_size_using_fd(fd, cols, rows); } fn spawn_terminal(&mut self, file_to_open: Option) -> (RawFd, RawFd) { let orig_termios = self.orig_termios.lock().unwrap(); spawn_terminal(file_to_open, orig_termios.clone()) } fn read_from_tty_stdout(&mut self, fd: RawFd, buf: &mut [u8]) -> Result { unistd::read(fd, buf) } fn write_to_tty_stdin(&mut self, fd: RawFd, buf: &mut [u8]) -> Result { unistd::write(fd, buf) } fn tcdrain(&mut self, fd: RawFd) -> Result<(), nix::Error> { termios::tcdrain(fd) } fn box_clone(&self) -> Box { Box::new((*self).clone()) } fn kill(&mut self, pid: RawFd) -> Result<(), nix::Error> { // TODO: // Ideally, we should be using SIGINT rather than SIGKILL here, but there are cases in which // the terminal we're trying to kill hangs on SIGINT and so all the app gets stuck // that's why we're sending SIGKILL here // A better solution would be to send SIGINT here and not wait for it, and then have // a background thread do the waitpid stuff and send SIGKILL if the process is stuck kill(Pid::from_raw(pid), Some(Signal::SIGKILL)).unwrap(); waitpid(Pid::from_raw(pid), None).unwrap(); Ok(()) } fn recv_from_client(&self) -> (ClientToServerMsg, ErrorContext) { self.receive_instructions_from_client .as_ref() .unwrap() .lock() .unwrap() .recv() } fn send_to_client(&self, msg: ServerToClientMsg) { self.send_instructions_to_client .lock() .unwrap() .as_mut() .unwrap() .send(msg); } fn add_client_sender(&mut self) { assert!(self.send_instructions_to_client.lock().unwrap().is_none()); let sender = self .receive_instructions_from_client .as_ref() .unwrap() .lock() .unwrap() .get_sender(); *self.send_instructions_to_client.lock().unwrap() = Some(sender); } fn update_receiver(&mut self, stream: LocalSocketStream) { self.receive_instructions_from_client = Some(Arc::new(Mutex::new(IpcReceiverWithContext::new(stream)))); } fn load_palette(&self) -> Palette { default_palette() } } impl Clone for Box { fn clone(&self) -> Box { self.box_clone() } } pub fn get_server_os_input() -> ServerOsInputOutput { let current_termios = termios::tcgetattr(0).unwrap(); let orig_termios = Arc::new(Mutex::new(current_termios)); ServerOsInputOutput { orig_termios, receive_instructions_from_client: None, send_instructions_to_client: Arc::new(Mutex::new(None)), } } #[derive(Clone)] pub struct ClientOsInputOutput { orig_termios: Arc>, send_instructions_to_server: Arc>>>, receive_instructions_from_server: Arc>>>, } /// The `ClientOsApi` trait represents an abstract interface to the features of an operating system that /// Zellij client requires. pub trait ClientOsApi: Send + Sync { /// Returns the size of the terminal associated to file descriptor `fd`. fn get_terminal_size_using_fd(&self, fd: RawFd) -> PositionAndSize; /// Set the terminal associated to file descriptor `fd` to /// [raw mode](https://en.wikipedia.org/wiki/Terminal_mode). fn set_raw_mode(&mut self, fd: RawFd); /// Set the terminal associated to file descriptor `fd` to /// [cooked mode](https://en.wikipedia.org/wiki/Terminal_mode). fn unset_raw_mode(&self, fd: RawFd); /// Returns the writer that allows writing to standard output. fn get_stdout_writer(&self) -> Box; /// Returns the raw contents of standard input. fn read_from_stdin(&self) -> Vec; /// Returns a [`Box`] pointer to this [`ClientOsApi`] struct. fn box_clone(&self) -> Box; /// Sends a message to the server. fn send_to_server(&self, msg: ClientToServerMsg); /// Receives a message on client-side IPC channel // This should be called from the client-side router thread only. fn recv_from_server(&self) -> (ServerToClientMsg, ErrorContext); fn handle_signals(&self, sigwinch_cb: Box, quit_cb: Box); /// Establish a connection with the server socket. fn connect_to_server(&self, path: &Path); } impl ClientOsApi for ClientOsInputOutput { fn get_terminal_size_using_fd(&self, fd: RawFd) -> PositionAndSize { get_terminal_size_using_fd(fd) } fn set_raw_mode(&mut self, fd: RawFd) { into_raw_mode(fd); } fn unset_raw_mode(&self, fd: RawFd) { let orig_termios = self.orig_termios.lock().unwrap(); unset_raw_mode(fd, orig_termios.clone()); } fn box_clone(&self) -> Box { Box::new((*self).clone()) } fn read_from_stdin(&self) -> Vec { let stdin = std::io::stdin(); let mut stdin = stdin.lock(); let buffer = stdin.fill_buf().unwrap(); let length = buffer.len(); let read_bytes = Vec::from(buffer); stdin.consume(length); read_bytes } fn get_stdout_writer(&self) -> Box { let stdout = ::std::io::stdout(); Box::new(stdout) } fn send_to_server(&self, msg: ClientToServerMsg) { self.send_instructions_to_server .lock() .unwrap() .as_mut() .unwrap() .send(msg); } fn recv_from_server(&self) -> (ServerToClientMsg, ErrorContext) { self.receive_instructions_from_server .lock() .unwrap() .as_mut() .unwrap() .recv() } fn handle_signals(&self, sigwinch_cb: Box, quit_cb: Box) { let mut signals = Signals::new(&[SIGWINCH, SIGTERM, SIGINT, SIGQUIT, SIGHUP]).unwrap(); for signal in signals.forever() { match signal { SIGWINCH => { sigwinch_cb(); } SIGTERM | SIGINT | SIGQUIT | SIGHUP => { quit_cb(); break; } _ => unreachable!(), } } } fn connect_to_server(&self, path: &Path) { let socket; loop { match LocalSocketStream::connect(path) { Ok(sock) => { socket = sock; break; } Err(_) => { std::thread::sleep(std::time::Duration::from_millis(50)); } } } let sender = IpcSenderWithContext::new(socket); let receiver = sender.get_receiver(); *self.send_instructions_to_server.lock().unwrap() = Some(sender); *self.receive_instructions_from_server.lock().unwrap() = Some(receiver); } } impl Clone for Box { fn clone(&self) -> Box { self.box_clone() } } pub fn get_client_os_input() -> ClientOsInputOutput { let current_termios = termios::tcgetattr(0).unwrap(); let orig_termios = Arc::new(Mutex::new(current_termios)); ClientOsInputOutput { orig_termios, send_instructions_to_server: Arc::new(Mutex::new(None)), receive_instructions_from_server: Arc::new(Mutex::new(None)), } }