org-clock-watch.el

;; Author: zongtao wang <wztdream@163.com>
;; Package-Requires: ((org) (notifications))

;;; Code:

(require 'org)
(require 'org-clock)
(require 'notifications)

(defvar org-clock-watch-timer nil "the timer that runs org-clock-watcher")
(defvar org-clock-watch-postponed-time 0 "accumulated postponed time")
(defvar org-clock-watch-overred-time 0 "over time value")

(defvar org-clock-watch-work-plan-file-path
  nil "the work plan org file path .")


(defvar org-clock-watch-total-on-time 0 "total time (sec) since turn on watcher")

(defvar org-clock-watch-choose-task-func nil
  " the function to choose the task
")

(defvar org-clock-watch-timer-file-path nil
  "the file path for timer, which is an org file path")

(defvar org-clock-watch-timer-id nil "the id of the heading, which is a string")

(defcustom org-clock-watch-nopop nil
  "not show pop up window if t, else show popup window"
  :group 'org-clock-watch
  :type 'boolean
  )

(defcustom org-clock-watch-auto-clock-in-p nil
  "non-nil will clock in the task defined by `org-clock-watch-timer-file-path' and
`org-clock-watch-timer-id' if there is no action from user, nil will turn off this function"
  :group 'org-clock-watch
  :type 'boolean)

(defcustom org-clock-watch-auto-clock-out-p nil
  "non-nil will auto clock out if idle time over threshold, nil will disable this function,
the idle time is calculate by `org-clock-x11idle-program-name'"
  :group 'org-clock-watch
  :type 'boolean)
(defcustom org-clock-watch-auto-clock-out-seconds 1800
  "auto clock out threshold in seconds"
  :group 'org-clock-watch
  :type 'integer)

(defcustom org-clock-watch-play-sound-command-str
  "aplay" "shell command name for play the sound file"
  :group 'org-clock-watch
  :type 'string)
(defcustom org-clock-watch-focus-emacs-window-command-str ""
  "shell command string to focus emacs window, empty string means this function is off,
on linux you can use `wmctrl -xa Emacs', on windows you can reference `nircmd' or other command
"
  :group 'org-clock-watch
  :type 'string)

(defcustom org-clock-watch-micro-rest-p nil
  "non-nil means will send micro rest alarm, nil will disable it"
  :group 'org-clock-watch
  :type 'boolean)

(defcustom org-clock-watch-idle-threshold-minutes
  "2min" "only computer idle smaller then this minutes, watcher will alarm"
  :group 'org-clock-watch
  :type 'string)

(defcustom org-clock-watch-clock-in-sound (when load-file-name
                                            (concat (file-name-directory load-file-name)
                                                    "resources/why-not-clock-in.wav"))
  "The path to a sound file that´s to be played when found no clock is running."
  :group 'org-clock-watch
  :type 'file)

(defcustom org-clock-watch-effort-sound (when load-file-name
                                          (concat (file-name-directory load-file-name)
                                                  "resources/why-not-set-an-effort.wav"))
  "The path to a sound file that´s to be played when found no clock is running."
  :group 'org-clock-watch
  :type 'file)

(defcustom org-clock-watch-overtime-notify-sound (when load-file-name
                                                   (concat (file-name-directory load-file-name)
                                                           "resources/why-not-a-comfortable-rest.wav"))
  "The path to a sound file that´s to be played when overtime."
  :group 'org-clock-watch
  :type 'file)

(defcustom org-clock-watch-overtime-icon (when load-file-name
                                           (concat (file-name-directory load-file-name)
                                                   "resources/beach.svg"))
  "The path to a icon file that´s to be show when overtime."
  :group 'org-clock-watch
  :type 'file)

(defcustom org-clock-watch-no-set-me-icon (when load-file-name
                                            (concat (file-name-directory load-file-name)
                                                    "resources/tomato.svg"))
  "The path to a icon file that´s to be show when overtime."
  :group 'org-clock-watch
  :type 'file)

(defcustom org-clock-watch-micro-rest-sound (when load-file-name
                                              (concat (file-name-directory load-file-name)
                                                      "resources/ding.wav"))
  "The path to a sound file that´s to be played when need micro rest."
  :group 'org-clock-watch
  :type 'file)

(defcustom org-clock-watch-overtime-notify-interval
  180 "over this seconds, will show over time notify"
  :group 'org-clock-watch
  :type 'integer)

(defcustom org-clock-watch-micro-rest-interval
  180 "micro rest means a very short time interval and a very small rest
such as stretch your body, shake your head every 3 min
" :group 'org-clock-watch
  :type 'integer)

(defcustom org-clock-watch-effort-notify-interval
  60 "interval in sec to notify set effort"
  :group 'org-clock-watch
  :type 'integer)

(defcustom org-clock-watch-clock-in-notify-interval
  180 "time interval to notify user set clock"
  :group 'org-clock-watch
  :type 'integer)
(defun org-clock-watch-start-heading-clock (id file effort)
  "Start clock programmatically for heading with ID in FILE, and set effort to EFFORT."
  (if-let (marker (org-id-find-id-in-file id file t))
      (save-current-buffer (save-excursion
                             (set-buffer (marker-buffer marker))
                             (goto-char (marker-position marker))
                             (org-clock-in)
                             (when effort
                               (org-set-effort nil effort))))
    (warn "Clock not started (Could not find ID '%s' in file '%s')"
          id file)))

(defun org-clock-watch-goto-work-plan ()
  "open work plan org file"
  (interactive)
  (unless (string= "" org-clock-watch-focus-emacs-window-command-str)
    (shell-command org-clock-watch-focus-emacs-window-command-str))
  (find-file org-clock-watch-work-plan-file-path))

(defun org-clock-watch-clock-in-action (id key)
  (cond
   ((string-equal key "task-back")
    ;;; t means switch window back after set task
    ;;; if you are using fire fox you may happy to switch back to fire fox
    ;;; after set task
    (funcall org-clock-watch-choose-task-func
             t))
   ((string-equal key "task")
    (funcall org-clock-watch-choose-task-func
             nil))
   ((string-equal key "last")
    (org-clock-in-last))
   (t (when (string-equal key "manual")
        (unless (string= "" org-clock-watch-focus-emacs-window-command-str)
          (shell-command org-clock-watch-focus-emacs-window-command-str))
        (setq key (read-string "effort:" nil nil "60min")))
      ;; start clock and set effort
      (org-clock-watch-start-heading-clock org-clock-watch-timer-id
                                           org-clock-watch-timer-file-path key))))

(defun org-clock-watch-clock-in-close (id reason)
  ;; start clock and set effort, here we set effort to nil
  ;; to allow auto clock with old effort in the task entry
  (when (and (equal reason 'expired) org-clock-watch-auto-clock-in-p)
    (org-clock-watch-start-heading-clock org-clock-watch-timer-id
                                         org-clock-watch-timer-file-path nil)))

(defun org-clock-watch-overtime-action (id key)
  (cond
   ((string-equal key "ok")
    (org-clock-out))
   ((string-equal key "show")
    (unless (string= "" org-clock-watch-focus-emacs-window-command-str)
      (shell-command org-clock-watch-focus-emacs-window-command-str))
    (org-clock-goto))
   ((string-equal key "resolve")
    (unless (string= "" org-clock-watch-focus-emacs-window-command-str)
      (shell-command org-clock-watch-focus-emacs-window-command-str))
    (org-resolve-clocks))
   (t
    ;; as we already over time, we need first modify effort to total time
    (org-clock-modify-effort-estimate (org-clock-get-clocked-time))
    ;; then add extra time
    (org-clock-modify-effort-estimate key))))

(defun org-clock-watcher ()
  "To watch org-clock status, if `org-clocking-p' is t and not set org-clock-watch,
then set org-clock-watch, if `org-clocking-p' is nil then notify to set org-clock,
you need to run this function as a timer, in you init file
"
  ;; tic-toc
  (setq org-clock-watch-total-on-time (1+ org-clock-watch-total-on-time))
  ;; auto clock out if system idle over threshold
  (when (and (org-clocking-p)
             org-clock-watch-auto-clock-out-p
             (> (org-x11-idle-seconds) org-clock-watch-auto-clock-out-seconds))
    (ignore-errors (org-clock-out nil t (time-subtract (current-time) (org-x11-idle-seconds))))
    (message "org-clock-watch: auto clock out due to idle"))
  ;; only alarm when not idle
  (when (< (org-x11-idle-seconds) (* 60 (org-duration-to-minutes org-clock-watch-idle-threshold-minutes)))
    (if (org-clocking-p)
        ;; org-clock is running
        (progn
          ;; when not set effort, then periodically notify user to set effort
          (when (and (or (null org-clock-effort)
                         (equal org-clock-effort ""))
                     (zerop (mod org-clock-watch-total-on-time org-clock-watch-effort-notify-interval)))
            (unless org-clock-watch-nopop
              (notifications-notify :title "Set an effort?"
                                  :urgency 'normal
                                  :app-icon org-clock-watch-no-set-me-icon
                                  :timeout 10000))
            (start-process "play sound" nil org-clock-watch-play-sound-command-str org-clock-watch-effort-sound)
            (run-at-time nil
                         nil
                         (lambda nil
                           (unless (string= "" org-clock-watch-focus-emacs-window-command-str)
                             (shell-command org-clock-watch-focus-emacs-window-command-str))
                           (org-set-effort))))
          ;; update over time
          (unless (or (null org-clock-effort) (equal org-clock-effort ""))
            (setq org-clock-watch-overred-time (- (org-time-convert-to-integer (org-time-since org-clock-start-time))
                                                  (* 60
                                                     (org-duration-to-minutes org-clock-effort)))))
          ;; overtime alarm
          (when (and (> org-clock-watch-overred-time 0)
                     (zerop (mod org-clock-watch-overred-time org-clock-watch-overtime-notify-interval)))
            (unless org-clock-watch-nopop
                (notifications-notify :title org-clock-current-task
                                   :urgency 'normal
                                   :body (format "over time <b> +%s min</b>"
                                                 (floor org-clock-watch-overred-time 60))
                                   :actions '("ok" "why not?"  "+5min" "+5m" "+10min" "+10m" "+20min" "+20m" "+30min" "+30m" "resolve" "resolve" "show" "show")
                                   :on-action 'org-clock-watch-overtime-action
                                   :app-icon org-clock-watch-overtime-icon
                                   :timeout 10000))
            (start-process "play sound" nil org-clock-watch-play-sound-command-str org-clock-watch-overtime-notify-sound)))
      ;; actions to take when org-clock is not running
      ;; notify to clock in
      (when (zerop (mod org-clock-watch-total-on-time org-clock-watch-clock-in-notify-interval))
        (unless org-clock-watch-nopop
          (notifications-notify :title "clock in?"
                              :urgency 'normal
                              :app-icon org-clock-watch-no-set-me-icon
                              :actions '("manual" "manual" "last" "last" "task" "task"
                                         "task-back" "task->" "30min" "30min" "45min"
                                         "45min" "60min" "60min" "90min" "90mim" "120min"
                                         "120min")
                              :on-action'org-clock-watch-clock-in-action
                              :on-close 'org-clock-watch-clock-in-close
                              :timeout 10000))
        (start-process "play sound" nil org-clock-watch-play-sound-command-str org-clock-watch-clock-in-sound)))
    ;; periodically sent micro rest alarm when system not idle
    (when (and org-clock-watch-micro-rest-p
               (zerop (mod org-clock-watch-total-on-time org-clock-watch-micro-rest-interval)))
      (start-process "play sound" nil org-clock-watch-play-sound-command-str org-clock-watch-micro-rest-sound))))


;;;###autoload
(defun org-clock-watch-toggle (&optional on-off)
  "start/stop the timer that runs org-clock-watcher
ON-OFF `C-u' or 'on means turn on, `C-u C-u' or 'off means turn off, `nil' means toggle
"
  (interactive "P")
  (cond
   ((null on-off)
    (if org-clock-watch-timer
        (setq org-clock-watch-timer (cancel-timer org-clock-watch-timer))
      (setq org-clock-watch-timer (run-with-timer 5 1 'org-clock-watcher))))
   ((or (equal on-off 'on)
        (equal on-off '(4)))
    (unless org-clock-watch-timer
      (setq org-clock-watch-timer (run-with-timer 5 1 'org-clock-watcher))))
   ((or (equal on-off 'off)
        (equal on-off '(16)))
    (when org-clock-watch-timer
      (setq org-clock-watch-timer (cancel-timer org-clock-watch-timer)))))
  (if org-clock-watch-timer
      (message "org-clock-watcher started")
    (message "org-clock-watcher stopped")))

(defun org-clock-watch-status ()
  "get the status of watcher"
  (interactive)
  (if org-clock-watch-timer
      (message "org-clock-watcher is running")
    (message "org-clock-watcher is stopped")))

(provide 'org-clock-watch)

;;code end here