1 ;;; timeclock.el --- mode for keeping track of how much you work
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
4 ;; Free Software Foundation, Inc.
6 ;; Author: John Wiegley <johnw@gnu.org>
7 ;; Created: 25 Mar 1999
9 ;; Keywords: calendar data
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; This mode is for keeping track of time intervals. You can use it
31 ;; for whatever purpose you like, but the typical scenario is to keep
32 ;; track of how much time you spend working on certain projects.
34 ;; Use `timeclock-in' when you start on a project, and `timeclock-out'
35 ;; when you're done. Once you've collected some data, you can use
36 ;; `timeclock-workday-remaining' to see how much time is left to be
37 ;; worked today (where `timeclock-workday' specifies the length of the
38 ;; working day), and `timeclock-when-to-leave' to calculate when you're free.
40 ;; You'll probably want to bind the timeclock commands to some handy
41 ;; keystrokes. At the moment, C-x t is unused:
43 ;; (require 'timeclock)
45 ;; (define-key ctl-x-map "ti" 'timeclock-in)
46 ;; (define-key ctl-x-map "to" 'timeclock-out)
47 ;; (define-key ctl-x-map "tc" 'timeclock-change)
48 ;; (define-key ctl-x-map "tr" 'timeclock-reread-log)
49 ;; (define-key ctl-x-map "tu" 'timeclock-update-modeline)
50 ;; (define-key ctl-x-map "tw" 'timeclock-when-to-leave-string)
52 ;; If you want Emacs to display the amount of time "left" to your
53 ;; workday in the modeline, you can either set the value of
54 ;; `timeclock-modeline-display' to t using M-x customize, or you
55 ;; can add this code to your .emacs file:
57 ;; (require 'timeclock)
58 ;; (timeclock-modeline-display)
60 ;; To cancel this modeline display at any time, just call
61 ;; `timeclock-modeline-display' again.
63 ;; You may also want Emacs to ask you before exiting, if you are
64 ;; currently working on a project. This can be done either by setting
65 ;; `timeclock-ask-before-exiting' to t using M-x customize (this is
66 ;; the default), or by adding the following to your .emacs file:
68 ;; (add-hook 'kill-emacs-query-functions 'timeclock-query-out)
70 ;; NOTE: If you change your .timelog file without using timeclock's
71 ;; functions, or if you change the value of any of timeclock's
72 ;; customizable variables, you should run the command
73 ;; `timeclock-reread-log'. This will recompute any discrepancies in
74 ;; your average working time, and will make sure that the various
75 ;; display functions return the correct value.
81 (defgroup timeclock nil
82 "Keeping track of the time that gets spent."
87 (defcustom timeclock-file
(convert-standard-filename "~/.timelog")
88 "*The file used to store timeclock data in."
92 (defcustom timeclock-workday
(* 8 60 60)
93 "*The length of a work period."
97 (defcustom timeclock-relative t
98 "*Whether to make reported time relative to `timeclock-workday'.
99 For example, if the length of a normal workday is eight hours, and you
100 work four hours on Monday, then the amount of time \"remaining\" on
101 Tuesday is twelve hours -- relative to an averaged work period of
102 eight hours -- or eight hours, non-relative. So relative time takes
103 into account any discrepancy of time under-worked or over-worked on
104 previous days. This only affects the timeclock modeline display."
108 (defcustom timeclock-get-project-function
'timeclock-ask-for-project
109 "*The function used to determine the name of the current project.
110 When clocking in, and no project is specified, this function will be
111 called to determine what is the current project to be worked on.
112 If this variable is nil, no questions will be asked."
116 (defcustom timeclock-get-reason-function
'timeclock-ask-for-reason
117 "*A function used to determine the reason for clocking out.
118 When clocking out, and no reason is specified, this function will be
119 called to determine what is the reason.
120 If this variable is nil, no questions will be asked."
124 (defcustom timeclock-get-workday-function nil
125 "*A function used to determine the length of today's workday.
126 The first time that a user clocks in each day, this function will be
127 called to determine what is the length of the current workday. If
128 the return value is nil, or equal to `timeclock-workday', nothing special
129 will be done. If it is a quantity different from `timeclock-workday',
130 however, a record will be output to the timelog file to note the fact that
131 that day has a length that is different from the norm."
132 :type
'(choice (const nil
) function
)
135 (defcustom timeclock-ask-before-exiting t
136 "*If non-nil, ask if the user wants to clock out before exiting Emacs.
137 This variable only has effect if set with \\[customize]."
138 :set
(lambda (symbol value
)
140 (add-hook 'kill-emacs-query-functions
'timeclock-query-out
)
141 (remove-hook 'kill-emacs-query-functions
'timeclock-query-out
))
142 (setq timeclock-ask-before-exiting value
))
146 (defvar timeclock-update-timer nil
147 "The timer used to update `timeclock-mode-string'.")
149 ;; For byte-compiler.
150 (defvar display-time-hook
)
151 (defvar timeclock-modeline-display
)
153 (defcustom timeclock-use-display-time t
154 "*If non-nil, use `display-time-hook' for doing modeline updates.
155 The advantage of this is that one less timer has to be set running
156 amok in Emacs' process space. The disadvantage is that it requires
157 you to have `display-time' running. If you don't want to use
158 `display-time', but still want the modeline to show how much time is
159 left, set this variable to nil. Changing the value of this variable
160 while timeclock information is being displayed in the modeline has no
161 effect. You should call the function `timeclock-modeline-display' with
162 a positive argument to force an update."
163 :set
(lambda (symbol value
)
164 (let ((currently-displaying
165 (and (boundp 'timeclock-modeline-display
)
166 timeclock-modeline-display
)))
167 ;; if we're changing to the state that
168 ;; `timeclock-modeline-display' is already using, don't
169 ;; bother toggling it. This happens on the initial loading
171 (if (and currently-displaying
173 (boundp 'display-time-hook
)
174 (memq 'timeclock-update-modeline
177 timeclock-update-timer
)))
178 (setq currently-displaying nil
))
179 (and currently-displaying
180 (set-variable 'timeclock-modeline-display nil
))
181 (setq timeclock-use-display-time value
)
182 (and currently-displaying
183 (set-variable 'timeclock-modeline-display t
))
184 timeclock-use-display-time
))
189 (defcustom timeclock-first-in-hook nil
190 "*A hook run for the first \"in\" event each day.
191 Note that this hook is run before recording any events. Thus the
192 value of `timeclock-hours-today', `timeclock-last-event' and the
193 return value of function `timeclock-last-period' are relative previous
198 (defcustom timeclock-load-hook nil
199 "*Hook that gets run after timeclock has been loaded."
203 (defcustom timeclock-in-hook nil
204 "*A hook run every time an \"in\" event is recorded."
208 (defcustom timeclock-day-over-hook nil
209 "*A hook that is run when the workday has been completed.
210 This hook is only run if the current time remaining is being displayed
211 in the modeline. See the variable `timeclock-modeline-display'."
215 (defcustom timeclock-out-hook nil
216 "*A hook run every time an \"out\" event is recorded."
220 (defcustom timeclock-done-hook nil
221 "*A hook run every time a project is marked as completed."
225 (defcustom timeclock-event-hook nil
226 "*A hook run every time any event is recorded."
230 (defvar timeclock-last-event nil
231 "A list containing the last event that was recorded.
232 The format of this list is (CODE TIME PROJECT).")
234 (defvar timeclock-last-event-workday nil
235 "The number of seconds in the workday of `timeclock-last-event'.")
237 ;;; Internal Variables:
239 (defvar timeclock-discrepancy nil
240 "A variable containing the time discrepancy before the last event.
241 Normally, timeclock assumes that you intend to work for
242 `timeclock-workday' seconds every day. Any days in which you work
243 more or less than this amount is considered either a positive or
244 a negative discrepancy. If you work in such a manner that the
245 discrepancy is always brought back to zero, then you will by
246 definition have worked an average amount equal to `timeclock-workday'
249 (defvar timeclock-elapsed nil
250 "A variable containing the time elapsed for complete periods today.
251 This value is not accurate enough to be useful by itself. Rather,
252 call `timeclock-workday-elapsed', to determine how much time has been
253 worked so far today. Also, if `timeclock-relative' is nil, this value
254 will be the same as `timeclock-discrepancy'.")
256 (defvar timeclock-use-elapsed nil
257 "Non-nil if the modeline should display time elapsed, not remaining.")
259 (defvar timeclock-last-period nil
260 "Integer representing the number of seconds in the last period.
261 Note that you shouldn't access this value, but instead should use the
262 function `timeclock-last-period'.")
264 (defvar timeclock-mode-string nil
265 "The timeclock string (optionally) displayed in the modeline.
266 The time is bracketed by <> if you are clocked in, otherwise by [].")
268 (defvar timeclock-day-over nil
269 "The date of the last day when notified \"day over\" for.")
274 (defun timeclock-modeline-display (&optional arg
)
275 "Toggle display of the amount of time left today in the modeline.
276 If `timeclock-use-display-time' is non-nil (the default), then
277 the function `display-time-mode' must be active, and the modeline
278 will be updated whenever the time display is updated. Otherwise,
279 the timeclock will use its own sixty second timer to do its
280 updating. With prefix ARG, turn modeline display on if and only
281 if ARG is positive. Returns the new status of timeclock modeline
282 display (non-nil means on)."
284 ;; cf display-time-mode.
285 (setq timeclock-mode-string
"")
286 (or global-mode-string
(setq global-mode-string
'("")))
288 (> (prefix-numeric-value arg
) 0)
289 (not timeclock-modeline-display
))))
292 (or (memq 'timeclock-mode-string global-mode-string
)
293 (setq global-mode-string
294 (append global-mode-string
'(timeclock-mode-string))))
295 (unless (memq 'timeclock-update-modeline timeclock-event-hook
)
296 (add-hook 'timeclock-event-hook
'timeclock-update-modeline
))
297 (when timeclock-update-timer
298 (cancel-timer timeclock-update-timer
)
299 (setq timeclock-update-timer nil
))
300 (if (boundp 'display-time-hook
)
301 (remove-hook 'display-time-hook
'timeclock-update-modeline
))
302 (if timeclock-use-display-time
304 ;; Update immediately so there is a visible change
305 ;; on calling this function.
306 (if display-time-mode
(timeclock-update-modeline)
307 (message "Activate `display-time-mode' or turn off \
308 `timeclock-use-display-time' to see timeclock information"))
309 (add-hook 'display-time-hook
'timeclock-update-modeline
))
310 (setq timeclock-update-timer
311 (run-at-time nil
60 'timeclock-update-modeline
))))
312 (setq global-mode-string
313 (delq 'timeclock-mode-string global-mode-string
))
314 (remove-hook 'timeclock-event-hook
'timeclock-update-modeline
)
315 (if (boundp 'display-time-hook
)
316 (remove-hook 'display-time-hook
317 'timeclock-update-modeline
))
318 (when timeclock-update-timer
319 (cancel-timer timeclock-update-timer
)
320 (setq timeclock-update-timer nil
)))
321 (force-mode-line-update)
322 (setq timeclock-modeline-display on-p
)))
324 ;; This has to be here so that the function definition of
325 ;; `timeclock-modeline-display' is known to the "set" function.
326 (defcustom timeclock-modeline-display nil
327 "Toggle modeline display of time remaining.
328 You must modify via \\[customize] for this variable to have an effect."
329 :set
(lambda (symbol value
)
330 (setq timeclock-modeline-display
331 (timeclock-modeline-display (or value
0))))
336 (defsubst timeclock-time-to-date
(time)
337 "Convert the TIME value to a textual date string."
338 (format-time-string "%Y/%m/%d" time
))
341 (defun timeclock-in (&optional arg project find-project
)
342 "Clock in, recording the current time moment in the timelog.
343 With a numeric prefix ARG, record the fact that today has only that
344 many hours in it to be worked. If arg is a non-numeric prefix arg
345 \(non-nil, but not a number), 0 is assumed (working on a holiday or
346 weekend). *If not called interactively, ARG should be the number of
347 _seconds_ worked today*. This feature only has effect the first time
348 this function is called within a day.
350 PROJECT is the project being clocked into. If PROJECT is nil, and
351 FIND-PROJECT is non-nil -- or the user calls `timeclock-in'
352 interactively -- call the function `timeclock-get-project-function' to
353 discover the name of the project."
355 (list (and current-prefix-arg
356 (if (numberp current-prefix-arg
)
357 (* current-prefix-arg
60 60)
359 (if (equal (car timeclock-last-event
) "i")
360 (error "You've already clocked in!")
361 (unless timeclock-last-event
362 (timeclock-reread-log))
363 ;; Either no log file, or day has rolled over.
364 (unless (and timeclock-last-event
365 (equal (timeclock-time-to-date
366 (cadr timeclock-last-event
))
367 (timeclock-time-to-date (current-time))))
368 (let ((workday (or (and (numberp arg
) arg
)
370 (and timeclock-get-workday-function
371 (funcall timeclock-get-workday-function
))
373 (run-hooks 'timeclock-first-in-hook
)
374 ;; settle the discrepancy for the new day
375 (setq timeclock-discrepancy
376 (- (or timeclock-discrepancy
0) workday
))
377 (if (not (= workday timeclock-workday
))
378 (timeclock-log "h" (number-to-string
379 (/ workday
(if (zerop (% workday
(* 60 60)))
381 (timeclock-log "i" (or project
382 (and timeclock-get-project-function
383 (or find-project
(interactive-p))
384 (funcall timeclock-get-project-function
))))
385 (run-hooks 'timeclock-in-hook
)))
388 (defun timeclock-out (&optional arg reason find-reason
)
389 "Clock out, recording the current time moment in the timelog.
390 If a prefix ARG is given, the user has completed the project that was
391 begun during the last time segment.
393 REASON is the user's reason for clocking out. If REASON is nil, and
394 FIND-REASON is non-nil -- or the user calls `timeclock-out'
395 interactively -- call the function `timeclock-get-reason-function' to
396 discover the reason."
398 (or timeclock-last-event
399 (error "You haven't clocked in!"))
400 (if (equal (downcase (car timeclock-last-event
)) "o")
401 (error "You've already clocked out!")
405 (and timeclock-get-reason-function
406 (or find-reason
(interactive-p))
407 (funcall timeclock-get-reason-function
))))
408 (run-hooks 'timeclock-out-hook
)
410 (run-hooks 'timeclock-done-hook
))))
412 ;; Should today-only be removed in favour of timeclock-relative? - gm
413 (defsubst timeclock-workday-remaining
(&optional today-only
)
414 "Return the number of seconds until the workday is complete.
415 The amount returned is relative to the value of `timeclock-workday'.
416 If TODAY-ONLY is non-nil, the value returned will be relative only to
417 the time worked today, and not to past time."
418 (let ((discrep (timeclock-find-discrep)))
420 (- (if today-only
(cadr discrep
)
425 (defun timeclock-status-string (&optional show-seconds today-only
)
426 "Report the overall timeclock status at the present moment.
427 If SHOW-SECONDS is non-nil, display second resolution.
428 If TODAY-ONLY is non-nil, the display will be relative only to time
429 worked today, ignoring the time worked on previous days."
431 (let ((remainder (timeclock-workday-remaining
433 (not timeclock-relative
))))
434 (last-in (equal (car timeclock-last-event
) "i"))
437 (format "Currently %s since %s (%s), %s %s, leave at %s"
438 (if last-in
"IN" "OUT")
440 (format-time-string "%-I:%M:%S %p"
441 (nth 1 timeclock-last-event
))
442 (format-time-string "%-I:%M %p"
443 (nth 1 timeclock-last-event
)))
444 (or (nth 2 timeclock-last-event
)
445 (if last-in
"**UNKNOWN**" "workday over"))
446 (timeclock-seconds-to-string remainder show-seconds t
)
449 (timeclock-when-to-leave-string show-seconds today-only
)))
451 (message "%s" status
)
455 (defun timeclock-change (&optional arg project
)
456 "Change to working on a different project.
457 This clocks out of the current project, then clocks in on a new one.
458 With a prefix ARG, consider the previous project as finished at the
459 time of changeover. PROJECT is the name of the last project you were
463 (timeclock-in nil project
(interactive-p)))
466 (defun timeclock-query-out ()
467 "Ask the user whether to clock out.
468 This is a useful function for adding to `kill-emacs-query-functions'."
469 (and (equal (car timeclock-last-event
) "i")
470 (y-or-n-p "You're currently clocking time, clock out? ")
472 ;; Unconditionally return t for `kill-emacs-query-functions'.
476 (defun timeclock-reread-log ()
477 "Re-read the timeclock, to account for external changes.
478 Returns the new value of `timeclock-discrepancy'."
480 (setq timeclock-discrepancy nil
)
481 (timeclock-find-discrep)
482 (if (and timeclock-discrepancy timeclock-modeline-display
)
483 (timeclock-update-modeline))
484 timeclock-discrepancy
)
486 (defun timeclock-seconds-to-string (seconds &optional show-seconds
488 "Convert SECONDS into a compact time string.
489 If SHOW-SECONDS is non-nil, make the resolution of the return string
490 include the second count. If REVERSE-LEADER is non-nil, it means to
491 output a \"+\" if the time value is negative, rather than a \"-\".
492 This is used when negative time values have an inverted meaning (such
493 as with time remaining, where negative time really means overtime)."
495 (format "%s%d:%02d:%02d"
496 (if (< seconds
0) (if reverse-leader
"+" "-") "")
497 (truncate (/ (abs seconds
) 60 60))
498 (%
(truncate (/ (abs seconds
) 60)) 60)
499 (%
(truncate (abs seconds
)) 60))
501 (if (< seconds
0) (if reverse-leader
"+" "-") "")
502 (truncate (/ (abs seconds
) 60 60))
503 (%
(truncate (/ (abs seconds
) 60)) 60))))
505 (defsubst timeclock-currently-in-p
()
506 "Return non-nil if the user is currently clocked in."
507 (equal (car timeclock-last-event
) "i"))
510 (defun timeclock-workday-remaining-string (&optional show-seconds
512 "Return a string representing the amount of time left today.
513 Display second resolution if SHOW-SECONDS is non-nil. If TODAY-ONLY
514 is non-nil, the display will be relative only to time worked today.
515 See `timeclock-relative' for more information about the meaning of
516 \"relative to today\"."
518 (let ((string (timeclock-seconds-to-string
519 (timeclock-workday-remaining today-only
)
522 (message "%s" string
)
525 (defsubst timeclock-workday-elapsed
()
526 "Return the number of seconds worked so far today.
527 If RELATIVE is non-nil, the amount returned will be relative to past
528 time worked. The default is to return only the time that has elapsed
530 (let ((discrep (timeclock-find-discrep)))
536 (defun timeclock-workday-elapsed-string (&optional show-seconds
)
537 "Return a string representing the amount of time worked today.
538 Display seconds resolution if SHOW-SECONDS is non-nil. If RELATIVE is
539 non-nil, the amount returned will be relative to past time worked."
541 (let ((string (timeclock-seconds-to-string (timeclock-workday-elapsed)
544 (message "%s" string
)
547 (defsubst timeclock-time-to-seconds
(time)
548 "Convert TIME to a floating point number."
549 (+ (* (car time
) 65536.0)
551 (/ (or (car (cdr (cdr time
))) 0) 1000000.0)))
553 (defsubst timeclock-seconds-to-time
(seconds)
554 "Convert SECONDS (a floating point number) to an Emacs time structure."
555 (list (floor seconds
65536)
556 (floor (mod seconds
65536))
557 (floor (* (- seconds
(ffloor seconds
)) 1000000))))
559 ;; Should today-only be removed in favour of timeclock-relative? - gm
560 (defsubst timeclock-when-to-leave
(&optional today-only
)
561 "Return a time value representing the end of today's workday.
562 If TODAY-ONLY is non-nil, the value returned will be relative only to
563 the time worked today, and not to past time."
564 (timeclock-seconds-to-time
565 (- (timeclock-time-to-seconds (current-time))
566 (let ((discrep (timeclock-find-discrep)))
574 (defun timeclock-when-to-leave-string (&optional show-seconds
576 "Return a string representing the end of today's workday.
577 This string is relative to the value of `timeclock-workday'. If
578 SHOW-SECONDS is non-nil, the value printed/returned will include
579 seconds. If TODAY-ONLY is non-nil, the value returned will be
580 relative only to the time worked today, and not to past time."
581 ;; Should today-only be removed in favour of timeclock-relative? - gm
583 (let* ((then (timeclock-when-to-leave today-only
))
586 (format-time-string "%-I:%M:%S %p" then
)
587 (format-time-string "%-I:%M %p" then
))))
589 (message "%s" string
)
592 (defun timeclock-make-hours-explicit (old-default)
593 "Specify all workday lengths in `timeclock-file'.
594 OLD-DEFAULT hours are set for every day that has no number indicated."
596 (if old-default
(setq old-default
(prefix-numeric-value old-default
))
597 (error "timelog-make-hours-explicit requires an explicit argument"))
598 (let ((extant-timelog (find-buffer-visiting timeclock-file
))
600 (with-current-buffer (find-file-noselect timeclock-file t
)
605 (goto-char (point-min))
606 (while (progn (skip-chars-forward "\n") (not (eobp)))
607 ;; This is just a variant of `timeclock-moment-regexp'.
609 (concat "^\\([bhioO]\\) \\([0-9]+/[0-9]+/[0-9]+\\) "
610 "\\([0-9]+:[0-9]+:[0-9]+\\)"))
611 (error "Can't parse `%s'" timeclock-file
))
612 (let ((this-date (match-string 2)))
613 (unless (or (and current-date
614 (string= this-date current-date
))
615 (string= (match-string 1) "h"))
616 (insert (format "h %s %s %s\n" (match-string 2)
617 (match-string 3) old-default
)))
618 (if (string-match "^[ih]" (match-string 1)) ; ignore logouts
619 (setq current-date this-date
)))
622 (unless extant-timelog
(kill-buffer (current-buffer)))))))
624 ;;; Internal Functions:
626 (defvar timeclock-project-list nil
)
627 (defvar timeclock-last-project nil
)
629 (defun timeclock-completing-read (prompt alist
&optional default
)
630 "A version of `completing-read' that works on both Emacs and XEmacs."
631 (if (featurep 'xemacs
)
632 (let ((str (completing-read prompt alist
)))
633 (if (or (null str
) (= (length str
) 0))
636 (completing-read prompt alist nil nil nil nil default
)))
638 (defun timeclock-ask-for-project ()
639 "Ask the user for the project they are clocking into."
640 (timeclock-completing-read
641 (format "Clock into which project (default %s): "
642 (or timeclock-last-project
643 (car timeclock-project-list
)))
644 (mapcar 'list timeclock-project-list
)
645 (or timeclock-last-project
646 (car timeclock-project-list
))))
648 (defvar timeclock-reason-list nil
)
650 (defun timeclock-ask-for-reason ()
651 "Ask the user for the reason they are clocking out."
652 (timeclock-completing-read "Reason for clocking out: "
653 (mapcar 'list timeclock-reason-list
)))
655 (defun timeclock-update-modeline ()
656 "Update the `timeclock-mode-string' displayed in the modeline.
657 The value of `timeclock-relative' affects the display as described in
658 that variable's documentation."
661 (if timeclock-use-elapsed
662 (timeclock-workday-elapsed)
663 (timeclock-workday-remaining (not timeclock-relative
))))
664 (last-in (equal (car timeclock-last-event
) "i")))
665 (when (and (< remainder
0)
666 (not (and timeclock-day-over
667 (equal timeclock-day-over
668 (timeclock-time-to-date
670 (setq timeclock-day-over
671 (timeclock-time-to-date (current-time)))
672 (run-hooks 'timeclock-day-over-hook
))
673 (setq timeclock-mode-string
677 (timeclock-seconds-to-string remainder nil t
)
679 'help-echo
"timeclock: time remaining"))))
681 (put 'timeclock-mode-string
'risky-local-variable t
)
683 (defun timeclock-log (code &optional project
)
684 "Log the event CODE to the timeclock log, at the time of call.
685 If PROJECT is a string, it represents the project which the event is
686 being logged for. Normally only \"in\" events specify a project."
687 (let ((extant-timelog (find-buffer-visiting timeclock-file
)))
688 (with-current-buffer (find-file-noselect timeclock-file t
)
692 (goto-char (point-max))
695 (let ((now (current-time)))
697 (format-time-string "%Y/%m/%d %H:%M:%S" now
)
698 (or (and (stringp project
)
699 (> (length project
) 0)
700 (concat " " project
))
703 (if (equal (downcase code
) "o")
704 (setq timeclock-last-period
705 (- (timeclock-time-to-seconds now
)
706 (timeclock-time-to-seconds
707 (cadr timeclock-last-event
)))
708 timeclock-discrepancy
709 (+ timeclock-discrepancy
710 timeclock-last-period
)))
711 (setq timeclock-last-event
(list code now project
)))))
713 (unless extant-timelog
(kill-buffer (current-buffer)))))
714 (run-hooks 'timeclock-event-hook
))
716 (defvar timeclock-moment-regexp
717 (concat "\\([bhioO]\\)\\s-+"
718 "\\([0-9]+\\)/\\([0-9]+\\)/\\([0-9]+\\)\\s-+"
719 "\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)[ \t]*" "\\([^\n]*\\)"))
721 (defsubst timeclock-read-moment
()
722 "Read the moment under point from the timelog."
723 (if (looking-at timeclock-moment-regexp
)
724 (let ((code (match-string 1))
725 (year (string-to-number (match-string 2)))
726 (mon (string-to-number (match-string 3)))
727 (mday (string-to-number (match-string 4)))
728 (hour (string-to-number (match-string 5)))
729 (min (string-to-number (match-string 6)))
730 (sec (string-to-number (match-string 7)))
731 (project (match-string 8)))
732 (list code
(encode-time sec min hour mday mon year
) project
))))
734 (defun timeclock-last-period (&optional moment
)
735 "Return the value of the last event period.
736 If the last event was a clock-in, the period will be open ended, and
737 growing every second. Otherwise, it is a fixed amount which has been
738 recorded to disk. If MOMENT is non-nil, use that as the current time.
739 This is only provided for coherency when used by
740 `timeclock-discrepancy'."
741 (if (equal (car timeclock-last-event
) "i")
742 (- (timeclock-time-to-seconds (or moment
(current-time)))
743 (timeclock-time-to-seconds
744 (cadr timeclock-last-event
)))
745 timeclock-last-period
))
747 (defsubst timeclock-entry-length
(entry)
748 (- (timeclock-time-to-seconds (cadr entry
))
749 (timeclock-time-to-seconds (car entry
))))
751 (defsubst timeclock-entry-begin
(entry)
754 (defsubst timeclock-entry-end
(entry)
757 (defsubst timeclock-entry-project
(entry)
760 (defsubst timeclock-entry-comment
(entry)
764 (defsubst timeclock-entry-list-length
(entry-list)
767 (setq length
(+ length
(timeclock-entry-length (car entry-list
))))
768 (setq entry-list
(cdr entry-list
)))
771 (defsubst timeclock-entry-list-begin
(entry-list)
772 (timeclock-entry-begin (car entry-list
)))
774 (defsubst timeclock-entry-list-end
(entry-list)
775 (timeclock-entry-end (car (last entry-list
))))
777 (defsubst timeclock-entry-list-span
(entry-list)
778 (- (timeclock-time-to-seconds (timeclock-entry-list-end entry-list
))
779 (timeclock-time-to-seconds (timeclock-entry-list-begin entry-list
))))
781 (defsubst timeclock-entry-list-break
(entry-list)
782 (- (timeclock-entry-list-span entry-list
)
783 (timeclock-entry-list-length entry-list
)))
785 (defsubst timeclock-entry-list-projects
(entry-list)
788 (let ((project (timeclock-entry-project (car entry-list
))))
790 (add-to-list 'projects project
)
791 (setq projects
(list project
))))
792 (setq entry-list
(cdr entry-list
)))
796 (defsubst timeclock-day-required
(day)
797 (or (car day
) timeclock-workday
))
799 (defsubst timeclock-day-length
(day)
800 (timeclock-entry-list-length (cdr day
)))
802 (defsubst timeclock-day-debt
(day)
803 (- (timeclock-day-required day
)
804 (timeclock-day-length day
)))
806 (defsubst timeclock-day-begin
(day)
807 (timeclock-entry-list-begin (cdr day
)))
809 (defsubst timeclock-day-end
(day)
810 (timeclock-entry-list-end (cdr day
)))
812 (defsubst timeclock-day-span
(day)
813 (timeclock-entry-list-span (cdr day
)))
815 (defsubst timeclock-day-break
(day)
816 (timeclock-entry-list-break (cdr day
)))
818 (defsubst timeclock-day-projects
(day)
819 (timeclock-entry-list-projects (cdr day
)))
821 (defmacro timeclock-day-list-template
(func)
824 (setq length
(+ length
(,(eval func
) (car day-list
))))
825 (setq day-list
(cdr day-list
)))
828 (defun timeclock-day-list-required (day-list)
829 (timeclock-day-list-template 'timeclock-day-required
))
831 (defun timeclock-day-list-length (day-list)
832 (timeclock-day-list-template 'timeclock-day-length
))
834 (defun timeclock-day-list-debt (day-list)
835 (timeclock-day-list-template 'timeclock-day-debt
))
837 (defsubst timeclock-day-list-begin
(day-list)
838 (timeclock-day-begin (car day-list
)))
840 (defsubst timeclock-day-list-end
(day-list)
841 (timeclock-day-end (car (last day-list
))))
843 (defun timeclock-day-list-span (day-list)
844 (timeclock-day-list-template 'timeclock-day-span
))
846 (defun timeclock-day-list-break (day-list)
847 (timeclock-day-list-template 'timeclock-day-break
))
849 (defun timeclock-day-list-projects (day-list)
852 (let ((projs (timeclock-day-projects (car day-list
))))
855 (add-to-list 'projects
(car projs
))
856 (setq projects
(list (car projs
))))
857 (setq projs
(cdr projs
))))
858 (setq day-list
(cdr day-list
)))
862 (defsubst timeclock-current-debt
(&optional log-data
)
863 (nth 0 (or log-data
(timeclock-log-data))))
865 (defsubst timeclock-day-alist
(&optional log-data
)
866 (nth 1 (or log-data
(timeclock-log-data))))
868 (defun timeclock-day-list (&optional log-data
)
869 (let ((alist (timeclock-day-alist log-data
))
872 (setq day-list
(cons (cdar alist
) day-list
)
876 (defsubst timeclock-project-alist
(&optional log-data
)
877 (nth 2 (or log-data
(timeclock-log-data))))
880 (defun timeclock-log-data (&optional recent-only filename
)
881 "Return the contents of the timelog file, in a useful format.
882 If the optional argument RECENT-ONLY is non-nil, only show the contents
883 from the last point where the time debt (see below) was set.
884 If the optional argument FILENAME is non-nil, it is used instead of
885 the file specified by `timeclock-file.'
887 A timelog contains data in the form of a single entry per line.
888 Each entry has the form:
890 CODE YYYY/MM/DD HH:MM:SS [COMMENT]
892 CODE is one of: b, h, i, o or O. COMMENT is optional when the code is
893 i, o or O. The meanings of the codes are:
895 b Set the current time balance, or \"time debt\". Useful when
896 archiving old log data, when a debt must be carried forward.
897 The COMMENT here is the number of seconds of debt.
899 h Set the required working time for the given day. This must
900 be the first entry for that day. The COMMENT in this case is
901 the number of hours in this workday. Floating point amounts
904 i Clock in. The COMMENT in this case should be the name of the
907 o Clock out. COMMENT is unnecessary, but can be used to provide
908 a description of how the period went, for example.
910 O Final clock out. Whatever project was being worked on, it is
911 now finished. Useful for creating summary reports.
913 When this function is called, it will return a data structure with the
916 (DEBT ENTRIES-BY-DAY ENTRIES-BY-PROJECT)
918 DEBT is a floating point number representing the number of seconds
919 \"owed\" before any work was done. For a new file (one without a 'b'
920 entry), this is always zero.
922 The two entries lists have similar formats. They are both alists,
923 where the CAR is the index, and the CDR is a list of time entries.
924 For ENTRIES-BY-DAY, the CAR is a textual date string, of the form
925 YYYY/MM/DD. For ENTRIES-BY-PROJECT, it is the name of the project
926 worked on, or t for the default project.
928 The CDR for ENTRIES-BY-DAY is slightly different than for
929 ENTRIES-BY-PROJECT. It has the following form:
931 (DAY-LENGTH TIME-ENTRIES...)
933 For ENTRIES-BY-PROJECT, there is no DAY-LENGTH member. It is simply a
934 list of TIME-ENTRIES. Note that if DAY-LENGTH is nil, it means
935 whatever is the default should be used.
937 A TIME-ENTRY is a recorded time interval. It has the following format
938 \(although generally one does not have to manipulate these entries
939 directly; see below):
941 (BEGIN-TIME END-TIME PROJECT [COMMENT] [FINAL-P])
943 Anyway, suffice it to say there are a lot of structures. Typically
944 the user is expected to manipulate to the day(s) or project(s) that he
945 or she wants, at which point the following helper functions may be
948 timeclock-day-required
955 timeclock-day-projects
957 timeclock-day-list-required
958 timeclock-day-list-length
959 timeclock-day-list-debt
960 timeclock-day-list-begin
961 timeclock-day-list-end
962 timeclock-day-list-span
963 timeclock-day-list-break
964 timeclock-day-list-projects
966 timeclock-entry-length
967 timeclock-entry-begin
969 timeclock-entry-project
970 timeclock-entry-comment
972 timeclock-entry-list-length
973 timeclock-entry-list-begin
974 timeclock-entry-list-end
975 timeclock-entry-list-span
976 timeclock-entry-list-break
977 timeclock-entry-list-projects
979 A few comments should make the use of the above functions obvious:
981 `required' is the amount of time that must be spent during a day, or
982 sequence of days, in order to have no debt.
984 `length' is the actual amount of time that was spent.
986 `debt' is the difference between required time and length. A
987 negative debt signifies overtime.
989 `begin' is the earliest moment at which work began.
991 `end' is the final moment work was done.
993 `span' is the difference between begin and end.
995 `break' is the difference between span and length.
997 `project' is the project that was worked on, and `projects' is a
998 list of all the projects that were worked on during a given period.
1000 `comment', where it applies, could mean anything.
1002 There are a few more functions available, for locating day and entry
1005 timeclock-day-alist LOG-DATA
1006 timeclock-project-alist LOG-DATA
1007 timeclock-current-debt LOG-DATA
1009 See the documentation for the given function if more info is needed."
1010 (let* ((log-data (list 0.0 nil nil
))
1011 (now (current-time))
1012 (todays-date (timeclock-time-to-date now
))
1013 last-date-limited last-date-seconds last-date
1014 (line 0) last beg day entry event
)
1016 (insert-file-contents (or filename timeclock-file
))
1018 (goto-char (point-max))
1019 (unless (re-search-backward "^b\\s-+" nil t
)
1020 (goto-char (point-min))))
1021 (while (or (setq event
(timeclock-read-moment))
1023 (setq last t event
(list "o" now
))))
1024 (setq line
(1+ line
))
1025 (cond ((equal (car event
) "b")
1026 (setcar log-data
(string-to-number (nth 2 event
))))
1027 ((equal (car event
) "h")
1028 (setq last-date-limited
(timeclock-time-to-date (cadr event
))
1029 last-date-seconds
(* (string-to-number (nth 2 event
))
1031 ((equal (car event
) "i")
1033 (error "Error in format of timelog file, line %d" line
)
1035 (setq entry
(list (cadr event
) nil
1036 (and (> (length (nth 2 event
)) 0)
1038 (let ((date (timeclock-time-to-date (cadr event
))))
1040 (not (equal date last-date
)))
1042 (setcar (cdr log-data
)
1043 (cons (cons last-date day
)
1045 (setq day
(list (and last-date-limited
1046 last-date-seconds
))))
1048 (setq day
(list (and last-date-limited
1049 last-date-seconds
)))))
1050 (setq last-date date
1051 last-date-limited nil
)))
1052 ((equal (downcase (car event
)) "o")
1054 (error "Error in format of timelog file, line %d" line
)
1056 (setcar (cdr entry
) (cadr event
))
1057 (let ((desc (and (> (length (nth 2 event
)) 0)
1060 (nconc entry
(list (nth 2 event
))))
1061 (if (equal (car event
) "O")
1062 (nconc entry
(if desc
1065 (nconc day
(list entry
))
1066 (setq desc
(nth 2 entry
))
1067 (let ((proj (assoc desc
(nth 2 log-data
))))
1069 (setcar (cddr log-data
)
1070 (cons (cons desc
(list entry
))
1071 (car (cddr log-data
))))
1072 (nconc (cdr proj
) (list entry
)))))))
1075 (setcar (cdr log-data
)
1076 (cons (cons last-date day
)
1080 (defun timeclock-find-discrep ()
1081 "Calculate time discrepancies, in seconds.
1082 The result is a three element list, containing the total time
1083 discrepancy, today's discrepancy, and the time worked today."
1084 ;; This is not implemented in terms of the functions above, because
1085 ;; it's a bit wasteful to read all of that data in, just to throw
1086 ;; away more than 90% of the information afterwards.
1088 ;; If it were implemented using those functions, it would look
1089 ;; something like this:
1090 ;; (let ((days (timeclock-day-alist (timeclock-log-data)))
1093 ;; (setq total (+ total (- (timeclock-day-length (cdar days))
1094 ;; (timeclock-day-required (cdar days))))
1095 ;; days (cdr days)))
1097 (let* ((now (current-time))
1098 (todays-date (timeclock-time-to-date now
))
1099 (first t
) (accum 0) (elapsed 0)
1100 event beg last-date avg
1101 last-date-limited last-date-seconds
)
1102 (unless timeclock-discrepancy
1103 (when (file-readable-p timeclock-file
)
1104 (setq timeclock-project-list nil
1105 timeclock-last-project nil
1106 timeclock-reason-list nil
1107 timeclock-elapsed
0)
1109 (insert-file-contents timeclock-file
)
1110 (goto-char (point-max))
1111 (unless (re-search-backward "^b\\s-+" nil t
)
1112 (goto-char (point-min)))
1113 (while (setq event
(timeclock-read-moment))
1114 (cond ((equal (car event
) "b")
1115 (setq accum
(string-to-number (nth 2 event
))))
1116 ((equal (car event
) "h")
1117 (setq last-date-limited
1118 (timeclock-time-to-date (cadr event
))
1120 (* (string-to-number (nth 2 event
)) 3600.0)))
1121 ((equal (car event
) "i")
1122 (when (and (nth 2 event
)
1123 (> (length (nth 2 event
)) 0))
1124 (add-to-list 'timeclock-project-list
(nth 2 event
))
1125 (setq timeclock-last-project
(nth 2 event
)))
1126 (let ((date (timeclock-time-to-date (cadr event
))))
1128 (not (equal date last-date
))
1131 accum
(- accum
(if last-date-limited
1133 timeclock-workday
))))
1134 (setq last-date date
1135 last-date-limited nil
)
1137 (error "Error in format of timelog file!")
1138 (setq beg
(timeclock-time-to-seconds (cadr event
))))))
1139 ((equal (downcase (car event
)) "o")
1140 (if (and (nth 2 event
)
1141 (> (length (nth 2 event
)) 0))
1142 (add-to-list 'timeclock-reason-list
(nth 2 event
)))
1144 (error "Error in format of timelog file!")
1145 (setq timeclock-last-period
1146 (- (timeclock-time-to-seconds (cadr event
)) beg
)
1147 accum
(+ timeclock-last-period accum
)
1149 (if (equal last-date todays-date
)
1150 (setq timeclock-elapsed
1151 (+ timeclock-last-period timeclock-elapsed
)))))
1152 (setq timeclock-last-event event
1153 timeclock-last-event-workday
1154 (if (equal (timeclock-time-to-date now
) last-date-limited
)
1158 (setq timeclock-discrepancy accum
))))
1159 (unless timeclock-last-event-workday
1160 (setq timeclock-last-event-workday timeclock-workday
))
1161 (setq accum
(or timeclock-discrepancy
0)
1162 elapsed
(or timeclock-elapsed elapsed
))
1163 (if timeclock-last-event
1164 (if (equal (car timeclock-last-event
) "i")
1165 (let ((last-period (timeclock-last-period now
)))
1166 (setq accum
(+ accum last-period
)
1167 elapsed
(+ elapsed last-period
)))
1168 (if (not (equal (timeclock-time-to-date
1169 (cadr timeclock-last-event
))
1170 (timeclock-time-to-date now
)))
1171 (setq accum
(- accum timeclock-last-event-workday
)))))
1172 (list accum
(- elapsed timeclock-last-event-workday
)
1175 ;;; A reporting function that uses timeclock-log-data
1177 (defun timeclock-day-base (&optional time
)
1178 "Given a time within a day, return 0:0:0 within that day.
1179 If optional argument TIME is non-nil, use that instead of the current time."
1180 (let ((decoded (decode-time (or time
(current-time)))))
1181 (setcar (nthcdr 0 decoded
) 0)
1182 (setcar (nthcdr 1 decoded
) 0)
1183 (setcar (nthcdr 2 decoded
) 0)
1184 (apply 'encode-time decoded
)))
1186 (defun timeclock-mean (l)
1187 "Compute the arithmetic mean of the values in the list L."
1191 (setq total
(+ total
(car l
))
1198 (defun timeclock-generate-report (&optional html-p
)
1199 "Generate a summary report based on the current timelog file.
1200 By default, the report is in plain text, but if the optional argument
1201 HTML-P is non-nil, HTML markup is added."
1203 (let ((log (timeclock-log-data))
1204 (today (timeclock-day-base)))
1205 (if html-p
(insert "<p>"))
1206 (insert "Currently ")
1207 (let ((project (nth 2 timeclock-last-event
))
1208 (begin (nth 1 timeclock-last-event
))
1210 (if (timeclock-currently-in-p)
1212 (if (or (null project
) (= (length project
) 0))
1213 (progn (insert "Done Working Today")
1217 (insert " since " (format-time-string "%Y/%m/%d %-I:%M %p" begin
))
1219 (insert "<br>\n<b>")
1221 (if (timeclock-currently-in-p)
1222 (insert "Working on "))
1224 (insert project
"</b><br>\n")
1225 (insert project
"*\n"))
1226 (let ((proj-data (cdr (assoc project
(timeclock-project-alist log
))))
1227 (two-weeks-ago (timeclock-seconds-to-time
1228 (- (timeclock-time-to-seconds today
)
1230 two-week-len today-len
)
1232 (if (not (time-less-p
1233 (timeclock-entry-begin (car proj-data
)) today
))
1234 (setq today-len
(timeclock-entry-list-length proj-data
)
1236 (if (and (null two-week-len
)
1238 (timeclock-entry-begin (car proj-data
))
1240 (setq two-week-len
(timeclock-entry-list-length proj-data
)))
1241 (setq proj-data
(cdr proj-data
))))
1242 (if (null two-week-len
)
1243 (setq two-week-len today-len
))
1244 (if html-p
(insert "<p>"))
1246 (insert "\nTime spent on this task today: "
1247 (timeclock-seconds-to-string today-len
)
1248 ". In the last two weeks: "
1249 (timeclock-seconds-to-string two-week-len
))
1251 (insert "\nTime spent on this task in the last two weeks: "
1252 (timeclock-seconds-to-string two-week-len
))))
1253 (if html-p
(insert "<br>"))
1255 (timeclock-seconds-to-string (timeclock-workday-elapsed))
1257 (timeclock-seconds-to-string (timeclock-workday-remaining))
1258 " remaining, done at "
1259 (timeclock-when-to-leave-string) "\n")))
1260 (if html-p
(insert "<p>"))
1261 (insert "\nThere have been "
1263 (length (timeclock-day-alist log
)))
1264 " days of activity, starting "
1265 (caar (last (timeclock-day-alist log
))))
1266 (if html-p
(insert "</p>"))
1270 <td width=\"25\"><br></td><td>
1271 <table border=1 cellpadding=3>
1272 <tr><th><i>Statistics</i></th>
1279 (let* ((day-list (timeclock-day-list))
1280 (thirty-days-ago (timeclock-seconds-to-time
1281 (- (timeclock-time-to-seconds today
)
1283 (three-months-ago (timeclock-seconds-to-time
1284 (- (timeclock-time-to-seconds today
)
1286 (six-months-ago (timeclock-seconds-to-time
1287 (- (timeclock-time-to-seconds today
)
1289 (one-year-ago (timeclock-seconds-to-time
1290 (- (timeclock-time-to-seconds today
)
1292 (time-in (vector (list t
) (list t
) (list t
) (list t
) (list t
)))
1293 (time-out (vector (list t
) (list t
) (list t
) (list t
) (list t
)))
1294 (breaks (vector (list t
) (list t
) (list t
) (list t
) (list t
)))
1295 (workday (vector (list t
) (list t
) (list t
) (list t
) (list t
)))
1296 (lengths (vector '(0 0) thirty-days-ago three-months-ago
1297 six-months-ago one-year-ago
)))
1298 ;; collect statistics from complete timelog
1302 (unless (time-less-p
1303 (timeclock-day-begin (car day-list
))
1305 (let ((base (timeclock-time-to-seconds
1307 (timeclock-day-begin (car day-list
))))))
1308 (nconc (aref time-in i
)
1309 (list (- (timeclock-time-to-seconds
1310 (timeclock-day-begin (car day-list
)))
1312 (let ((span (timeclock-day-span (car day-list
)))
1313 (len (timeclock-day-length (car day-list
)))
1314 (req (timeclock-day-required (car day-list
))))
1315 ;; If the day's actual work length is less than
1316 ;; 70% of its span, then likely the exit time
1317 ;; and break amount are not worthwhile adding to
1319 (when (and (> span
0)
1320 (> (/ (float len
) (float span
)) 0.70))
1321 (nconc (aref time-out i
)
1322 (list (- (timeclock-time-to-seconds
1323 (timeclock-day-end (car day-list
)))
1325 (nconc (aref breaks i
) (list (- span len
))))
1327 (setq len
(+ len
(- timeclock-workday req
))))
1328 (nconc (aref workday i
) (list len
)))))
1330 (setq day-list
(cdr day-list
)))
1331 ;; average statistics
1334 (aset time-in i
(timeclock-mean (cdr (aref time-in i
))))
1335 (aset time-out i
(timeclock-mean (cdr (aref time-out i
))))
1336 (aset breaks i
(timeclock-mean (cdr (aref breaks i
))))
1337 (aset workday i
(timeclock-mean (cdr (aref workday i
))))
1339 ;; Output the HTML table
1341 (insert "<td align=\"center\">Time in</td>\n")
1344 (insert "<td align=\"right\">"
1345 (timeclock-seconds-to-string (aref time-in i
))
1351 (insert "<td align=\"center\">Time out</td>\n")
1354 (insert "<td align=\"right\">"
1355 (timeclock-seconds-to-string (aref time-out i
))
1361 (insert "<td align=\"center\">Break</td>\n")
1364 (insert "<td align=\"right\">"
1365 (timeclock-seconds-to-string (aref breaks i
))
1371 (insert "<td align=\"center\">Workday</td>\n")
1374 (insert "<td align=\"right\">"
1375 (timeclock-seconds-to-string (aref workday i
))
1380 <td colspan=\"6\" align=\"center\">
1381 <i>These are approximate figures</i></td>
1386 ;;; A helpful little function
1388 (defun timeclock-visit-timelog ()
1389 "Open the file named by `timeclock-file' in another window."
1391 (find-file-other-window timeclock-file
))
1393 (provide 'timeclock
)
1395 (run-hooks 'timeclock-load-hook
)
1397 ;; make sure we know the list of reasons, projects, and have computed
1398 ;; the last event and current discrepancy.
1399 (if (file-readable-p timeclock-file
)
1400 (timeclock-reread-log))
1402 ;;; arch-tag: a0be3377-deb6-44ec-b9a2-a7be28436a40
1403 ;;; timeclock.el ends here