i3status_rs/blocks/custom.rs
1 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 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
//! The output of a custom shell command
//!
//! For further customisation, use the `json` option and have the shell command output valid JSON in the schema below:
//! ```json
//! {"icon": "...", "state": "...", "text": "...", "short_text": "..."}
//! ```
//! `icon` is optional (default "")
//! `state` is optional, it may be Idle, Info, Good, Warning, Critical (default Idle)
//! `short_text` is optional.
//!
//! # Configuration
//!
//! Key | Values | Default
//! ----|--------|--------
//! `format` | A string to customise the output of this block. See below for available placeholders. | <code>\"{ $icon\|} $text.pango-str() \"</code>
//! `command` | Shell command to execute & display | `None`
//! `persistent` | Run command in the background; update display for each output line of the command | `false`
//! `cycle` | Commands to execute and change when the button is clicked | `None`
//! `interval` | Update interval in seconds (or "once" to update only once) | `10`
//! `json` | Use JSON from command output to format the block. If the JSON is not valid, the block will error out. | `false`
//! `watch_files` | Watch files to trigger update on file modification. Supports path expansions e.g. `~`. | `None`
//! `hide_when_empty` | Hides the block when the command output (or json text field) is empty | `false`
//! `shell` | Specify the shell to use when running commands | `$SHELL` if set, otherwise fallback to `sh`
//!
//! Placeholder | Value | Type | Unit
//! -----------------|------------------------------------------------------------|--------|---------------
//! `icon` | Value of icon field from JSON output when it's non-empty | Icon | -
//! `text` | Output of the script or text field from JSON output | Text |
//! `short_text` | short_text field from JSON output | Text |
//!
//! Action | Default button
//! --------|---------------
//! `cycle` | Left
//!
//! # Examples
//!
//! Display temperature, update every 10 seconds:
//!
//! ```toml
//! [[block]]
//! block = "custom"
//! command = ''' cat /sys/class/thermal/thermal_zone0/temp | awk '{printf("%.1f\n",$1/1000)}' '''
//! ```
//!
//! Cycle between "ON" and "OFF", update every 1 second, run next cycle command when block is clicked:
//!
//! ```toml
//! [[block]]
//! block = "custom"
//! cycle = ["echo ON", "echo OFF"]
//! interval = 1
//! [[block.click]]
//! button = "left"
//! action = "cycle"
//! ```
//!
//! Use JSON output:
//!
//! ```toml
//! [[block]]
//! block = "custom"
//! command = "echo '{\"icon\":\"weather_thunder\",\"state\":\"Critical\", \"text\": \"Danger!\"}'"
//! json = true
//! ```
//!
//! Display kernel, update the block only once:
//!
//! ```toml
//! [[block]]
//! block = "custom"
//! command = "uname -r"
//! interval = "once"
//! ```
//!
//! Display the screen brightness on an intel machine and update this only when `pkill -SIGRTMIN+4 i3status-rs` is called:
//!
//! ```toml
//! [[block]]
//! block = "custom"
//! command = ''' cat /sys/class/backlight/intel_backlight/brightness | awk '{print $1}' '''
//! signal = 4
//! interval = "once"
//! ```
//!
//! Update block when one or more specified files are modified:
//!
//! ```toml
//! [[block]]
//! block = "custom"
//! command = "cat custom_status"
//! watch_files = ["custom_status"]
//! interval = "once"
//! ```
//!
//! # TODO:
//! - Use `shellexpand`
use crate::formatting::Format;
use super::prelude::*;
use inotify::{Inotify, WatchMask};
use std::process::Stdio;
use tokio::io::{self, AsyncBufReadExt, BufReader};
use tokio::process::Command;
#[derive(Deserialize, Debug, SmartDefault)]
#[serde(deny_unknown_fields, default)]
pub struct Config {
pub format: FormatConfig,
pub command: Option<String>,
pub persistent: bool,
pub cycle: Option<Vec<String>>,
#[default(10.into())]
pub interval: Seconds,
pub json: bool,
pub hide_when_empty: bool,
pub shell: Option<String>,
pub watch_files: Vec<ShellString>,
}
async fn update_bar(
stdout: &str,
hide_when_empty: bool,
json: bool,
api: &CommonApi,
format: Format,
) -> Result<()> {
let mut widget = Widget::new().with_format(format);
let text_empty;
if json {
match serde_json::from_str::<Input>(stdout).error("Invalid JSON") {
Ok(input) => {
text_empty = input.text.is_empty();
widget.set_values(map! {
"text" => Value::text(input.text),
[if !input.icon.is_empty()] "icon" => Value::icon(input.icon),
[if let Some(t) = input.short_text] "short_text" => Value::text(t)
});
widget.state = input.state;
}
Err(error) => return api.set_error(error),
}
} else {
text_empty = stdout.is_empty();
widget.set_values(map!("text" => Value::text(stdout.into())));
}
if text_empty && hide_when_empty {
api.hide()
} else {
api.set_widget(widget)
}
}
pub async fn run(config: &Config, api: &CommonApi) -> Result<()> {
api.set_default_actions(&[(MouseButton::Left, None, "cycle")])?;
let format = config.format.with_defaults(
"{ $icon|} $text.pango-str() ",
"{ $icon|} $short_text.pango-str() |",
)?;
let mut timer = config.interval.timer();
type FileStream = Pin<Box<dyn Stream<Item = io::Result<inotify::EventOwned>> + Send + Sync>>;
let mut file_updates: FileStream = match config.watch_files.as_slice() {
[] => Box::pin(futures::stream::pending()),
files => {
let notify = Inotify::init().error("Failed to start inotify")?;
let mut watches = notify.watches();
for file in files {
let file = file.expand()?;
watches
.add(
&*file,
WatchMask::MODIFY
| WatchMask::CLOSE_WRITE
| WatchMask::DELETE
| WatchMask::MOVE,
)
.error("Failed to add file watch")?;
}
Box::pin(
notify
.into_event_stream([0; 1024])
.error("Failed to create event stream")?,
)
}
};
let shell = config
.shell
.clone()
.or_else(|| std::env::var("SHELL").ok())
.unwrap_or_else(|| "sh".to_string());
if config.persistent {
let mut process = Command::new(&shell)
.args([
"-c",
config
.command
.as_deref()
.error("'command' must be specified when 'persistent' is set")?,
])
.stdout(Stdio::piped())
.stdin(Stdio::null())
.kill_on_drop(true)
.spawn()
.error("failed to run command")?;
let stdout = process
.stdout
.take()
.expect("child did not have a handle to stdout");
let mut reader = BufReader::new(stdout).lines();
tokio::spawn(async move {
let _ = process.wait().await;
});
loop {
let line = reader
.next_line()
.await
.error("error reading line from child process")?
.error("child process exited unexpectedly")?;
update_bar(
&line,
config.hide_when_empty,
config.json,
api,
format.clone(),
)
.await?;
}
} else {
let mut actions = api.get_actions()?;
let mut cycle = config
.cycle
.clone()
.or_else(|| config.command.clone().map(|cmd| vec![cmd]))
.error("either 'command' or 'cycle' must be specified")?
.into_iter()
.cycle();
let mut cmd = cycle.next().unwrap();
loop {
// Run command
let output = Command::new(&shell)
.args(["-c", &cmd])
.stdin(Stdio::null())
.output()
.await
.error("failed to run command")?;
let stdout = std::str::from_utf8(&output.stdout)
.error("the output of command is invalid UTF-8")?
.trim();
update_bar(
stdout,
config.hide_when_empty,
config.json,
api,
format.clone(),
)
.await?;
loop {
select! {
_ = timer.tick() => break,
_ = file_updates.next() => break,
_ = api.wait_for_update_request() => break,
Some(action) = actions.recv() => match action.as_ref() {
"cycle" => {
cmd = cycle.next().unwrap();
break;
}
_ => (),
}
}
}
}
}
}
#[derive(Deserialize, Debug, Default)]
#[serde(default)]
struct Input {
icon: String,
state: State,
text: String,
short_text: Option<String>,
}