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
//! Disk usage statistics
//!
//! # Configuration
//!
//! Key | Values | Default
//! ----|--------|--------
//! `path` | Path to collect information from. Supports path expansions e.g. `~`. | `"/"`
//! `interval` | Update time in seconds | `20`
//! `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $available "`
//! `format_alt` | If set, block will switch between `format` and `format_alt` on every click | `None`
//! `warning` | A value which will trigger warning block state | `20.0`
//! `alert` | A value which will trigger critical block state | `10.0`
//! `info_type` | Determines which information will affect the block state. Possible values are `"available"`, `"free"` and `"used"` | `"available"`
//! `alert_unit` | The unit of `alert` and `warning` options. If not set, percents are used. Possible values are `"B"`, `"KB"`, `"KiB"`, `"MB"`, `"MiB"`, `"GB"`, `"Gib"`, `"TB"` and `"TiB"` | `None`
//!
//! Placeholder | Value | Type | Unit
//! -------------|--------------------------------------------------------------------|--------|-------
//! `icon` | A static icon | Icon | -
//! `path` | The value of `path` option | Text | -
//! `percentage` | Free or used percentage. Depends on `info_type` | Number | %
//! `total` | Total disk space | Number | Bytes
//! `used` | Used disk space | Number | Bytes
//! `free` | Free disk space | Number | Bytes
//! `available` | Available disk space (free disk space minus reserved system space) | Number | Bytes
//!
//! Action | Description | Default button
//! ----------------|-------------------------------------------|---------------
//! `toggle_format` | Toggles between `format` and `format_alt` | Left
//!
//! # Examples
//!
//! ```toml
//! [[block]]
//! block = "disk_space"
//! info_type = "available"
//! alert_unit = "GB"
//! alert = 10.0
//! warning = 15.0
//! format = " $icon $available "
//! format_alt = " $icon $available / $total "
//! ```
//!
//! Update block on right click:
//!
//! ```toml
//! [[block]]
//! block = "disk_space"
//! [[block.click]]
//! button = "right"
//! update = true
//! ```
//!
//! Show the block only if less than 10GB is available:
//!
//! ```toml
//! [[block]]
//! block = "disk_space"
//! format = " $free.eng(range:..10e9) |"
//! ```
//!
//! # Icons Used
//! - `disk_drive`
// make_log_macro!(debug, "disk_space");
use super::prelude::*;
use crate::formatting::prefix::Prefix;
use nix::sys::statvfs::statvfs;
#[derive(Copy, Clone, Debug, Deserialize, SmartDefault)]
#[serde(rename_all = "lowercase")]
pub enum InfoType {
#[default]
Available,
Free,
Used,
}
#[derive(Deserialize, Debug, SmartDefault)]
#[serde(deny_unknown_fields, default)]
pub struct Config {
#[default("/".into())]
pub path: ShellString,
pub info_type: InfoType,
pub format: FormatConfig,
pub format_alt: Option<FormatConfig>,
pub alert_unit: Option<String>,
#[default(20.into())]
pub interval: Seconds,
#[default(20.0)]
pub warning: f64,
#[default(10.0)]
pub alert: f64,
}
pub async fn run(config: &Config, api: &CommonApi) -> Result<()> {
let mut actions = api.get_actions()?;
api.set_default_actions(&[(MouseButton::Left, None, "toggle_format")])?;
let mut format = config.format.with_default(" $icon $available ")?;
let mut format_alt = match &config.format_alt {
Some(f) => Some(f.with_default("")?),
None => None,
};
let unit = match config.alert_unit.as_deref() {
// Decimal
Some("TB") => Some(Prefix::Tera),
Some("GB") => Some(Prefix::Giga),
Some("MB") => Some(Prefix::Mega),
Some("KB") => Some(Prefix::Kilo),
// Binary
Some("TiB") => Some(Prefix::Tebi),
Some("GiB") => Some(Prefix::Gibi),
Some("MiB") => Some(Prefix::Mebi),
Some("KiB") => Some(Prefix::Kibi),
// Byte
Some("B") => Some(Prefix::One),
// Unknown
Some(x) => return Err(Error::new(format!("Unknown unit: '{x}'"))),
None => None,
};
let path = config.path.expand()?;
let mut timer = config.interval.timer();
loop {
let mut widget = Widget::new().with_format(format.clone());
let statvfs = statvfs(&*path).error("failed to retrieve statvfs")?;
// Casting to be compatible with 32-bit systems
#[allow(clippy::unnecessary_cast)]
let (total, used, available, free) = {
let total = (statvfs.blocks() as u64) * (statvfs.fragment_size() as u64);
let used = ((statvfs.blocks() as u64) - (statvfs.blocks_free() as u64))
* (statvfs.fragment_size() as u64);
let available = (statvfs.blocks_available() as u64) * (statvfs.block_size() as u64);
let free = (statvfs.blocks_free() as u64) * (statvfs.block_size() as u64);
(total, used, available, free)
};
let result = match config.info_type {
InfoType::Available => available,
InfoType::Free => free,
InfoType::Used => used,
} as f64;
let percentage = result / (total as f64) * 100.;
widget.set_values(map! {
"icon" => Value::icon("disk_drive"),
"path" => Value::text(path.to_string()),
"percentage" => Value::percents(percentage),
"total" => Value::bytes(total as f64),
"used" => Value::bytes(used as f64),
"available" => Value::bytes(available as f64),
"free" => Value::bytes(free as f64),
});
// Send percentage to alert check if we don't want absolute alerts
let alert_val_in_config_units = match unit {
Some(p) => p.apply(result),
None => percentage,
};
// Compute state
widget.state = match config.info_type {
InfoType::Used => {
if alert_val_in_config_units >= config.alert {
State::Critical
} else if alert_val_in_config_units >= config.warning {
State::Warning
} else {
State::Idle
}
}
InfoType::Free | InfoType::Available => {
if alert_val_in_config_units <= config.alert {
State::Critical
} else if alert_val_in_config_units <= config.warning {
State::Warning
} else {
State::Idle
}
}
};
api.set_widget(widget)?;
loop {
select! {
_ = timer.tick() => break,
_ = api.wait_for_update_request() => break,
Some(action) = actions.recv() => match action.as_ref() {
"toggle_format" => {
if let Some(format_alt) = &mut format_alt {
std::mem::swap(format_alt, &mut format);
break;
}
}
_ => (),
}
}
}
}
}