Add action to paste output of a command to a pane.

This is useful for quickly inserting dynamic snippets e.g. current date.
Also useful for people who use a terminal without osc52 over ssh, where
an external program can act as a "paste buffer" similar to functionality
of screen/tmux.

Author: doryiii

zellij-server/src/route.rs

@@ -1,4 +1,6 @@
 use std::collections::{BTreeMap, HashSet, VecDeque};
+use std::fs;
+use std::process::Command;
 use std::sync::{Arc, RwLock};
 
 use crate::thread_bus::ThreadSenders;
@@ -89,6 +91,24 @@ pub(crate) fn route_action(
                 ))
                 .with_context(err_context)?;
         },
+        Action::WriteCommandOutput(filename) => {
+            senders
+                .send_to_screen(ScreenInstruction::ClearScroll(client_id))
+                .with_context(err_context)?;
+            let mut cmd_with_args = filename.split(' ').map(String::from);
+            let cmd: String = cmd_with_args.next()
+                .with_context(|| format!("need to specify a command with WriteCommandOutput"))?;
+            let args: Vec<String> = cmd_with_args.collect();
+            let output = Command::new(cmd.clone())
+                .args(args.clone())
+                .output()
+                .with_context(err_context)?;
+            senders
+                .send_to_screen(ScreenInstruction::WriteCharacter(
+                    None, output.stdout, false, client_id,
+                ))
+                .with_context(err_context)?;
+        },
         Action::SwitchToMode(mode) => {
             let attrs = &client_attributes;
             senders

zellij-utils/assets/plugins/about.wasm

@@ -5,7 +5,7 @@ pub struct Action {
     pub name: i32,
     #[prost(
         oneof = "action::OptionalPayload",
-        tags = "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, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49"
+        tags = "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, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50"
     )]
     pub optional_payload: ::core::option::Option<action::OptionalPayload>,
 }
@@ -104,6 +104,8 @@ pub mod action {
         MoveTabPayload(i32),
         #[prost(message, tag = "49")]
         MouseEventPayload(super::MouseEventPayload),
+        #[prost(message, tag = "50")]
+        WriteCommandOutputPayload(super::WriteCommandOutputPayload),
     }
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
@@ -236,6 +238,12 @@ pub struct WriteCharsPayload {
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
+pub struct WriteCommandOutputPayload {
+    #[prost(string, tag = "1")]
+    pub filename: ::prost::alloc::string::String,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
 pub struct DumpScreenPayload {
     #[prost(string, tag = "1")]
     pub file_path: ::prost::alloc::string::String,
@@ -476,6 +484,7 @@ pub enum ActionName {
     KeybindPipe = 84,
     TogglePanePinned = 85,
     MouseEvent = 86,
+    WriteCommandOutput = 87,
 }
 impl ActionName {
     /// String value of the enum field names used in the ProtoBuf definition.
@@ -568,6 +577,7 @@ impl ActionName {
             ActionName::KeybindPipe => "KeybindPipe",
             ActionName::TogglePanePinned => "TogglePanePinned",
             ActionName::MouseEvent => "MouseEvent",
+            ActionName::WriteCommandOutput => "WriteCommandOutput",
         }
     }
     /// Creates an enum from field names used in the ProtoBuf definition.
@@ -657,6 +667,7 @@ impl ActionName {
             "KeybindPipe" => Some(Self::KeybindPipe),
             "TogglePanePinned" => Some(Self::TogglePanePinned),
             "MouseEvent" => Some(Self::MouseEvent),
+            "WriteCommandOutput" => Some(Self::WriteCommandOutput),
             _ => None,
         }
     }

zellij-utils/assets/plugins/compact-bar.wasm

@@ -401,6 +401,10 @@ pub enum CliAction {
     WriteChars {
         chars: String,
     },
+    /// Run the given command and paste its stdout to the terminal.
+    WriteCommandOutput {
+        filename: String,
+    },
     /// [increase|decrease] the focused panes area at the [left|down|up|right] border.
     Resize {
         resize: Resize,

zellij-utils/assets/plugins/configuration.wasm

@@ -106,6 +106,8 @@ pub enum Action {
     Write(Option<KeyWithModifier>, Vec<u8>, bool), // bool -> is_kitty_keyboard_protocol
     /// Write Characters to the terminal.
     WriteChars(String),
+    /// Write content of given file to the terminal.
+    WriteCommandOutput(String),
     /// Switch to the specified input mode.
     SwitchToMode(InputMode),
     /// Switch all connected clients to the specified input mode.
@@ -317,6 +319,9 @@ impl Action {
         match cli_action {
             CliAction::Write { bytes } => Ok(vec![Action::Write(None, bytes, false)]),
             CliAction::WriteChars { chars } => Ok(vec![Action::WriteChars(chars)]),
+            CliAction::WriteCommandOutput { filename } => {
+                Ok(vec![Action::WriteCommandOutput(filename)])
+            },
             CliAction::Resize { resize, direction } => Ok(vec![Action::Resize(resize, direction)]),
             CliAction::FocusNextPane => Ok(vec![Action::FocusNextPane]),
             CliAction::FocusPreviousPane => Ok(vec![Action::FocusPreviousPane]),

zellij-utils/assets/plugins/fixture-plugin-for-tests.wasm

@@ -440,6 +440,7 @@ impl Action {
     ) -> Result<Self, ConfigError> {
         match action_name {
             "WriteChars" => Ok(Action::WriteChars(string)),
+            "WriteCommandOutput" => Ok(Action::WriteCommandOutput(string)),
             "SwitchToMode" => match InputMode::from_str(string.as_str()) {
                 Ok(input_mode) => Ok(Action::SwitchToMode(input_mode)),
                 Err(_e) => {
@@ -587,6 +588,11 @@ impl Action {
                 node.push(string.clone());
                 Some(node)
             },
+            Action::WriteCommandOutput(string) => {
+                let mut node = KdlNode::new("WriteCommandOutput");
+                node.push(string.clone());
+                Some(node)
+            },
             Action::SwitchToMode(input_mode) => {
                 let mut node = KdlNode::new("SwitchToMode");
                 node.push(format!("{:?}", input_mode).to_lowercase());
@@ -1358,6 +1364,11 @@ impl TryFrom<(&KdlNode, &Options)> for Action {
                 action_arguments,
                 kdl_action
             ),
+            "WriteCommandOutput" => parse_kdl_action_char_or_string_arguments!(
+                action_name,
+                action_arguments,
+                kdl_action
+            ),
             "SwitchToMode" => parse_kdl_action_char_or_string_arguments!(
                 action_name,
                 action_arguments,
@@ -5355,6 +5366,7 @@ fn keybinds_to_string_with_all_actions() {
                         config_key_2 "config_value_2";
                     };
                 }
+                bind "Ctrl Alt k" { WriteCommandOutput "/dev/null"; }
             }
         }"#;
     let document: KdlDocument = fake_config.parse().unwrap();

zellij-utils/assets/plugins/plugin-manager.wasm

@@ -1,6 +1,6 @@
 ---
 source: zellij-utils/src/kdl/mod.rs
-assertion_line: 2731
+assertion_line: 5408
 expression: serialized.to_string()
 ---
 keybinds clear-defaults=true {
@@ -47,6 +47,7 @@ keybinds clear-defaults=true {
         }
         bind "Alt j" { GoToPreviousTab; }
         bind "Ctrl k" { MovePane "right"; }
+        bind "Ctrl Alt k" { WriteCommandOutput "/dev/null"; }
         bind "Alt k" { CloseTab; }
         bind "Ctrl l" { MovePaneBackwards; }
         bind "Alt l" { GoToTab 1; }
@@ -127,4 +128,3 @@ keybinds clear-defaults=true {
         bind "Alt z" { SearchInput 0; }
     }
 }
-

zellij-utils/assets/plugins/session-manager.wasm

@@ -53,6 +53,7 @@ message Action {
     CliPipePayload message_payload = 47;
     MoveTabDirection move_tab_payload = 48;
     MouseEventPayload mouse_event_payload = 49;
+    WriteCommandOutputPayload write_command_output_payload = 50;
   }
 }
 
@@ -151,6 +152,10 @@ message WriteCharsPayload {
   string chars = 1;
 }
 
+message WriteCommandOutputPayload {
+  string filename = 1;
+}
+
 message DumpScreenPayload {
   string file_path = 1;
   bool include_scrollback = 2;
@@ -241,6 +246,7 @@ enum ActionName {
     KeybindPipe = 84;
     TogglePanePinned = 85;
     MouseEvent = 86;
+    WriteCommandOutput = 87;
 }
 
 message Position {

zellij-utils/assets/plugins/status-bar.wasm

@@ -9,7 +9,7 @@ pub use super::generated_api::api::{
         PluginConfiguration as ProtobufPluginConfiguration, Position as ProtobufPosition,
         RunCommandAction as ProtobufRunCommandAction, ScrollAtPayload,
         SearchDirection as ProtobufSearchDirection, SearchOption as ProtobufSearchOption,
-        SwitchToModePayload, WriteCharsPayload, WritePayload,
+        SwitchToModePayload, WriteCommandOutputPayload, WriteCharsPayload, WritePayload,
     },
     input_mode::InputMode as ProtobufInputMode,
     resize::{Resize as ProtobufResize, ResizeDirection as ProtobufResizeDirection},
@@ -49,6 +49,14 @@ impl TryFrom<ProtobufAction> for Action {
                 },
                 _ => Err("Wrong payload for Action::WriteChars"),
             },
+            Some(ProtobufActionName::WriteCommandOutput) => {
+                match protobuf_action.optional_payload {
+                    Some(OptionalPayload::WriteCommandOutputPayload(paste_from_file_payload)) => {
+                        Ok(Action::WriteCommandOutput(paste_from_file_payload.filename))
+                    },
+                    _ => Err("Wrong payload for Action::WriteCommandOutput"),
+                }
+            },
             Some(ProtobufActionName::SwitchToMode) => match protobuf_action.optional_payload {
                 Some(OptionalPayload::SwitchToModePayload(switch_to_mode_payload)) => {
                     let input_mode: InputMode =
@@ -735,6 +743,12 @@ impl TryFrom<Action> for ProtobufAction {
                     chars: chars_to_write,
                 })),
             }),
+            Action::WriteCommandOutput(filename) => Ok(ProtobufAction {
+                name: ProtobufActionName::WriteCommandOutput as i32,
+                optional_payload: Some(OptionalPayload::WriteCommandOutputPayload(
+                    WriteCommandOutputPayload { filename: filename },
+                )),
+            }),
             Action::SwitchToMode(input_mode) => {
                 let input_mode: ProtobufInputMode = input_mode.try_into()?;
                 Ok(ProtobufAction {