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
//! A [pomodoro timer](https://en.wikipedia.org/wiki/Pomodoro_Technique)
//!
//! # Technique
//!
//! There are six steps in the original technique:
//! 1) Decide on the task to be done.
//! 2) Set the pomodoro timer (traditionally to 25 minutes).
//! 3) Work on the task.
//! 4) End work when the timer rings and put a checkmark on a piece of paper.
//! 5) If you have fewer than four checkmarks, take a short break (3–5 minutes) and then return to step 2.
//! 6) After four pomodoros, take a longer break (15–30 minutes), reset your checkmark count to zero, then go to step 1.
//!
//!
//! # Configuration
//!
//! Key | Values | Default
//! ----|--------|--------
//! `format` | A string to customise the output of this block. | <code>\" $icon{ $message|} \"</code>
//! `message` | Message when timer expires | `"Pomodoro over! Take a break!"`
//! `break_message` | Message when break is over | `"Break over! Time to work!"`
//! `notify_cmd` | A shell command to run as a notifier. `{msg}` will be substituted with either `message` or `break_message`. | `None`
//! `blocking_cmd` | Is `notify_cmd` blocking? If it is, then pomodoro block will wait until the command finishes before proceeding. Otherwise, you will have to click on the block in order to proceed. | `false`
//!
//! Placeholder | Value | Type
//! ------------|-------------------------------------|------
//! `icon` | A static icon | Icon
//! `message` | Current message | Text
//!
//! # Example
//!
//! Use `swaynag` as a notifier:
//!
//! ```toml
//! [[block]]
//! block = "pomodoro"
//! notify_cmd = "swaynag -m '{msg}'"
//! blocking_cmd = true
//! ```
//!
//! Use `notify-send` as a notifier:
//!
//! ```toml
//! [[block]]
//! block = "pomodoro"
//! notify_cmd = "notify-send '{msg}'"
//! blocking_cmd = false
//! ```
//!
//! # Icons Used
//! - `pomodoro`
//! - `pomodoro_started`
//! - `pomodoro_stopped`
//! - `pomodoro_paused`
//! - `pomodoro_break`
//!
//! # TODO
//! - Use different icons.
//! - Use format strings.
use tokio::sync::mpsc;
use super::prelude::*;
use crate::subprocess::{spawn_shell, spawn_shell_sync};
use std::time::Instant;
#[derive(Deserialize, Debug, SmartDefault)]
#[serde(deny_unknown_fields, default)]
pub struct Config {
pub format: FormatConfig,
#[default("Pomodoro over! Take a break!".into())]
pub message: String,
#[default("Break over! Time to work!".into())]
pub break_message: String,
pub notify_cmd: Option<String>,
pub blocking_cmd: bool,
}
struct Block<'a> {
widget: Widget,
actions: mpsc::UnboundedReceiver<BlockAction>,
api: &'a CommonApi,
block_config: &'a Config,
}
impl Block<'_> {
async fn set_text(&mut self, text: String) -> Result<()> {
let mut values = map!(
"icon" => Value::icon("pomodoro"),
);
if !text.is_empty() {
values.insert("message".into(), Value::text(text));
}
self.widget.set_values(values);
self.api.set_widget(self.widget.clone())
}
async fn wait_for_click(&mut self, button: &str) -> Result<()> {
while self.actions.recv().await.error("channel closed")? != button {}
Ok(())
}
async fn read_params(&mut self) -> Result<(Duration, Duration, u64)> {
let task_len = self.read_u64(25, "Task length:").await?;
let break_len = self.read_u64(5, "Break length:").await?;
let pomodoros = self.read_u64(4, "Pomodoros:").await?;
Ok((
Duration::from_secs(task_len * 60),
Duration::from_secs(break_len * 60),
pomodoros,
))
}
async fn read_u64(&mut self, mut number: u64, msg: &str) -> Result<u64> {
loop {
self.set_text(format!("{msg} {number}")).await?;
match &*self.actions.recv().await.error("channel closed")? {
"_left" => break,
"_up" => number += 1,
"_down" => number = number.saturating_sub(1),
_ => (),
}
}
Ok(number)
}
async fn run_pomodoro(
&mut self,
task_len: Duration,
break_len: Duration,
pomodoros: u64,
) -> Result<()> {
for pomodoro in 0..pomodoros {
// Task timer
self.widget.state = State::Idle;
let timer = Instant::now();
loop {
let elapsed = timer.elapsed();
if elapsed >= task_len {
break;
}
let left = task_len - elapsed;
let text = if pomodoro == 0 {
format!("{} min", (left.as_secs() + 59) / 60,)
} else {
format!(
"{} {} min",
"|".repeat(pomodoro as usize),
(left.as_secs() + 59) / 60,
)
};
self.set_text(text).await?;
select! {
_ = sleep(Duration::from_secs(10)) => (),
_ = self.wait_for_click("_middle") => return Ok(()),
}
}
// Show break message
self.widget.state = State::Good;
self.set_text(self.block_config.message.clone()).await?;
if let Some(cmd) = &self.block_config.notify_cmd {
let cmd = cmd.replace("{msg}", &self.block_config.message);
if self.block_config.blocking_cmd {
spawn_shell_sync(&cmd)
.await
.error("failed to run notify_cmd")?;
} else {
spawn_shell(&cmd).error("failed to run notify_cmd")?;
self.wait_for_click("_left").await?;
}
} else {
self.wait_for_click("_left").await?;
}
// No break after the last pomodoro
if pomodoro == pomodoros - 1 {
break;
}
// Break timer
let timer = Instant::now();
loop {
let elapsed = timer.elapsed();
if elapsed >= break_len {
break;
}
let left = break_len - elapsed;
self.set_text(format!("Break: {} min", (left.as_secs() + 59) / 60,))
.await?;
select! {
_ = sleep(Duration::from_secs(10)) => (),
_ = self.wait_for_click("_middle") => return Ok(()),
}
}
// Show task message
self.widget.state = State::Good;
self.set_text(self.block_config.break_message.clone())
.await?;
if let Some(cmd) = &self.block_config.notify_cmd {
let cmd = cmd.replace("{msg}", &self.block_config.break_message);
if self.block_config.blocking_cmd {
spawn_shell_sync(&cmd)
.await
.error("failed to run notify_cmd")?;
} else {
spawn_shell(&cmd).error("failed to run notify_cmd")?;
self.wait_for_click("_left").await?;
}
} else {
self.wait_for_click("_left").await?;
}
}
Ok(())
}
}
pub async fn run(block_config: &Config, api: &CommonApi) -> Result<()> {
api.set_default_actions(&[
(MouseButton::Left, None, "_left"),
(MouseButton::Middle, None, "_middle"),
(MouseButton::Right, None, "_right"),
(MouseButton::WheelUp, None, "_up"),
(MouseButton::WheelDown, None, "_down"),
])?;
let format = block_config
.format
.clone()
.with_default(" $icon{ $message|} ")?;
let widget = Widget::new().with_format(format);
let mut block = Block {
widget,
actions: api.get_actions()?,
api,
block_config,
};
loop {
// Send collaped block
block.widget.state = State::Idle;
block.set_text(String::new()).await?;
block.wait_for_click("_left").await?;
let (task_len, break_len, pomodoros) = block.read_params().await?;
block.run_pomodoro(task_len, break_len, pomodoros).await?;
}
}