Skip to content

Commit

Permalink
Add a new plugin in Time: Pomodoro Timer (#902)
Browse files Browse the repository at this point in the history 
* Pomodoro Timer

* Correct ``esac`` indentation
  • Loading branch information
@mkoura @tresni
mkoura authored and tresni committed Nov 14, 2017
1 parent 6fba0ab commit dc4091e
Showing 1 changed file with 314 additions and 0 deletions.
314 changes: 314 additions & 0 deletions Time/pomodoro2.30s.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,314 @@
#!/bin/bash

# <bitbar.title>Pomodoro Timer</bitbar.title>
# <bitbar.version>v1.0</bitbar.version>
# <bitbar.author>Martin Kourim</bitbar.author>
# <bitbar.author.github>mkoura</bitbar.author.github>
# <bitbar.desc>Timer that uses Pomodoro timeboxing</bitbar.desc>

# pomodoro duration
POMODORO=1500 # 25 min
# break duration
BREAK=240 # 4 min
# long break duration
LONG_BREAK=1200 # 20 min
# script to run
SCRIPT=""

# icons
TOMATO_ICON="🍅"
BREAK_ICON="☕"
LONG_BREAK_ICON="🎉"
PAUSE_BIG_ICON="▮▮"
PAUSE_ICON="⏸"
STOP_ICON="⏹"
CHECKED_ICON="✓"
UNCHECKED_ICON="✗"

# ---

# must be updated at least every $MAX_UPDATE_INTERVAL seconds
MAX_UPDATE_INTERVAL=60

[ -e /proc/uptime ] && LINUX="true" || LINUX=""

STATUS_FILE="$HOME/.bitbar_pomodoro"
[ ! -e "$STATUS_FILE" ] && : > "$STATUS_FILE"

read -r tstamp togo pomodoros state activity loop _ < <({ read -r line; echo "$line"; } < "$STATUS_FILE")

set_now() {
[ -n "$now" ] && return

# avoid spawning processes if possible
if [ -n "$LINUX" ]; then
now="$(read -r s _ < /proc/uptime && echo "${s%.*}")"
else
now="$(date +%s)"
fi
}

run_script() {
[ -x "$SCRIPT" ] && $SCRIPT "$@" &
}

notify_osd() {
if [ -n "$LINUX" ]; then
notify-send "$@" 2>/dev/null
else
osascript -e "display notification \"$*\" with title \"$TOMATO_ICON Pomodoro\"" 2>/dev/null
fi
}

status_write() {
echo "$tstamp $togo $pomodoros $state $activity $loop" > "$STATUS_FILE"
}

status_reset() {
tstamp=0; togo=0; pomodoros=0; state="STOP"; activity="pomodoro"; loop="${loop:-on}"
status_write
}

loop_toggle() {
[ "$loop" = "on" ] && loop="off" || loop="on"
status_write
}

pomodoro_start() {
set_now
tstamp="$now"; togo="$POMODORO"; state="RUN"; activity="pomodoro"
status_write
run_script start
}

pomodoro_break() {
set_now
tstamp="$now"; togo="$BREAK"; state="RUN"; activity="break"
status_write
run_script break
}

pomodoro_long_break() {
set_now
tstamp="$now"; togo="$LONG_BREAK"; pomodoros=0; state="RUN"; activity="long_break"
status_write
run_script long_break
}

stale_record() {
# detect stale records, i.e. when computer
# was turned off during pomodoro
case "$activity" in
"pomodoro")
local interval="$POMODORO"
;;
"break")
local interval="$BREAK"
;;
"long_break")
local interval="$LONG_BREAK"
;;
esac
if ((tdiff < 0)) || ((tdiff > (interval + MAX_UPDATE_INTERVAL + 1) )); then
status_reset
return 1
fi
return 0
}

pomodoro_update() {
case "$state" in
"STOP"|"PAUSE")
return
;;
"RUN")
;;
*)
status_reset
return
;;
esac

# RUN
set_now
tdiff="$((now - tstamp))"
stale_record || return 1
case "$activity" in
"pomodoro")
togo="$((POMODORO - tdiff))"
if [ "$togo" -le 0 ]; then
pomodoros="$((${pomodoros:-0} + 1))"
if [ "$pomodoros" -lt 4 ]; then
notify_osd "Pomodoro completed, take a break."
pomodoro_break
else
notify_osd "Four pomodoros completed, take a long break."
pomodoro_long_break
fi
fi
;;
"break")
togo="$((BREAK - tdiff))"
if [ "$togo" -le 0 ]; then
if [ "$loop" = "off" ]; then
notify_osd "Break is over."
status_reset
else
notify_osd "Break is over, focus on new pomodoro."
pomodoro_start
fi
fi
;;
"long_break")
togo="$((LONG_BREAK - tdiff))"
if [ "$togo" -le 0 ]; then
if [ "$loop" = "off" ]; then
notify_osd "Long break is over."
status_reset
else
notify_osd "Long break is over, focus on new pomodoro."
pomodoro_start
fi
fi
;;
*)
status_reset
;;
esac
}

pause_resume() {
pomodoro_update
case "$state" in
"RUN")
# pause
state="PAUSE"
status_write # saves also up-to-date "togo"
run_script pause
;;
"PAUSE")
# resume
set_now
# set new timestamp according to the saved "togo"
case "$activity" in
"pomodoro")
tstamp="$((now - (POMODORO - togo) ))"
;;
"break")
tstamp="$((now - (BREAK - togo) ))"
;;
"long_break")
tstamp="$((now - (LONG_BREAK - togo) ))"
;;
esac
state="RUN"
status_write
run_script resume
;;
*)
status_reset
;;
esac
}

calc_remaining_time() {
[ -n "$rem" ] && return
rem="$((togo / 60 % 60))"
res="$((togo % 60))"
}

print_remaining_time() {
calc_remaining_time
printf "%02d:%02d" "$rem" "$res"
}

print_remaining_minutes() {
calc_remaining_time
if [ "$rem" -eq 0 ]; then
printf "&lt;1m"
else
[ "$res" -ge 30 ] && remaining="$((rem + 1))" || remaining="$rem"
printf "%02dm" "$remaining"
fi
}

print_menu() {
case "$state" in
"STOP")
echo "$TOMATO_ICON"
echo "---"
echo "Pomodoro | bash=\"$0\" param1=start terminal=false refresh=true"
echo "Break | bash=\"$0\" param1=break terminal=false refresh=true"
echo "Long break | bash=\"$0\" param1=long_break terminal=false refresh=true"
;;
"RUN")
case "$activity" in
"pomodoro")
echo "$TOMATO_ICON $(print_remaining_minutes)"
local caption=""
;;
"break")
echo "$BREAK_ICON $(print_remaining_minutes)"
local caption="Break: "
;;
"long_break")
echo "$LONG_BREAK_ICON $(print_remaining_minutes)"
local caption="Long break: "
;;
esac
echo "---"
echo "${caption}$(print_remaining_time) | refresh=true"
echo "${PAUSE_ICON} pause | bash=\"$0\" param1=pause terminal=false refresh=true"
echo "${STOP_ICON} stop | bash=\"$0\" param1=stop terminal=false refresh=true"
;;
"PAUSE")
echo "$PAUSE_BIG_ICON $(print_remaining_minutes)"
echo "---"
case "$activity" in
"pomodoro")
local caption="Paused"
;;
"break")
local caption="Break"
;;
"long_break")
local caption="Long break"
;;
esac
echo "${caption}: $(print_remaining_time) | refresh=true"
echo "${PAUSE_ICON} resume | bash=\"$0\" param1=pause terminal=false refresh=true"
echo "${STOP_ICON} stop | bash=\"$0\" param1=stop terminal=false refresh=true"
;;
esac

echo "---"
if [ "$loop" = "off" ]; then local acheck="$UNCHECKED_ICON"; else local acheck="$CHECKED_ICON"; fi
echo "Loop pomodoros: ${acheck} | bash=\"$0\" param1=loop_toggle terminal=false refresh=true"
}

case "$1" in
"start")
pomodoro_start
;;
"stop")
status_reset
run_script stop
;;
"pause")
pause_resume
;;
"break")
pomodoro_break
;;
"long_break")
pomodoro_long_break
;;
"loop_toggle")
loop_toggle
;;
*)
pomodoro_update
;;
esac

print_menu

0 comments on commit dc4091e

Please sign in to comment.