Allow synchronous update of timestamps in CLOCK log.
[org-mode.git] / lisp / org-clock.el
1 ;;; org-clock.el --- The time clocking code for Org-mode
2
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 ;;   Free Software Foundation, Inc.
5
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.6
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
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 of the License, or
16 ;; (at your option) any later version.
17
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.
22
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28
29 ;; This file contains the time clocking code for Org-mode
30
31 (require 'org)
32 (require 'org-exp)
33 ;;; Code:
34
35 (eval-when-compile
36   (require 'cl))
37
38 (declare-function calendar-absolute-from-iso "cal-iso" (&optional date))
39 (declare-function notifications-notify "notifications" (&rest params))
40 (defvar org-time-stamp-formats)
41
42 (defgroup org-clock nil
43   "Options concerning clocking working time in Org-mode."
44   :tag "Org Clock"
45   :group 'org-progress)
46
47 (defcustom org-clock-into-drawer org-log-into-drawer
48   "Should clocking info be wrapped into a drawer?
49 When t, clocking info will always be inserted into a :LOGBOOK: drawer.
50 If necessary, the drawer will be created.
51 When nil, the drawer will not be created, but used when present.
52 When an integer and the number of clocking entries in an item
53 reaches or exceeds this number, a drawer will be created.
54 When a string, it names the drawer to be used.
55
56 The default for this variable is the value of `org-log-into-drawer',
57 which see."
58   :group 'org-todo
59   :group 'org-clock
60   :type '(choice
61           (const :tag "Always" t)
62           (const :tag "Only when drawer exists" nil)
63           (integer :tag "When at least N clock entries")
64           (const :tag "Into LOGBOOK drawer" "LOGBOOK")
65           (string :tag "Into Drawer named...")))
66
67 (defun org-clock-into-drawer ()
68   "Return the value of `org-clock-into-drawer', but let properties overrule.
69 If the current entry has or inherits a CLOCK_INTO_DRAWER
70 property, it will be used instead of the default value; otherwise
71 if the current entry has or inherits a LOG_INTO_DRAWER property,
72 it will be used instead of the default value.
73 The default is the value of the customizable variable `org-clock-into-drawer',
74 which see."
75   (let ((p (org-entry-get nil "CLOCK_INTO_DRAWER" 'inherit))
76         (q (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
77     (cond
78      ((or (not (or p q)) (equal p "nil") (equal q "nil")) org-clock-into-drawer)
79      ((or (equal p "t") (equal q "t")) "LOGBOOK")
80      ((not p) q)
81      (t p))))
82
83 (defcustom org-clock-out-when-done t
84   "When non-nil, clock will be stopped when the clocked entry is marked DONE.
85 DONE here means any DONE-like state.
86 A nil value means clock will keep running until stopped explicitly with
87 `C-c C-x C-o', or until the clock is started in a different item.
88 Instead of t, this can also be a list of TODO states that should trigger
89 clocking out."
90   :group 'org-clock
91   :type '(choice
92           (const :tag "No" nil)
93           (const :tag "Yes, when done" t)
94           (repeat :tag "State list"
95                   (string :tag "TODO keyword"))))
96
97 (defcustom org-clock-out-remove-zero-time-clocks nil
98   "Non-nil means remove the clock line when the resulting time is zero."
99   :group 'org-clock
100   :type 'boolean)
101
102 (defcustom org-clock-in-switch-to-state nil
103   "Set task to a special todo state while clocking it.
104 The value should be the state to which the entry should be
105 switched.  If the value is a function, it must take one
106 parameter (the current TODO state of the item) and return the
107 state to switch it to."
108   :group 'org-clock
109   :group 'org-todo
110   :type '(choice
111           (const :tag "Don't force a state" nil)
112           (string :tag "State")
113           (symbol :tag "Function")))
114
115 (defcustom org-clock-out-switch-to-state nil
116   "Set task to a special todo state after clocking out.
117 The value should be the state to which the entry should be
118 switched.  If the value is a function, it must take one
119 parameter (the current TODO state of the item) and return the
120 state to switch it to."
121   :group 'org-clock
122   :group 'org-todo
123   :type '(choice
124           (const :tag "Don't force a state" nil)
125           (string :tag "State")
126           (symbol :tag "Function")))
127
128 (defcustom org-clock-history-length 5
129   "Number of clock tasks to remember in history."
130   :group 'org-clock
131   :type 'integer)
132
133 (defcustom org-clock-goto-may-find-recent-task t
134   "Non-nil means `org-clock-goto' can go to recent task if no active clock."
135   :group 'org-clock
136   :type 'boolean)
137
138 (defcustom org-clock-heading-function nil
139   "When non-nil, should be a function to create `org-clock-heading'.
140 This is the string shown in the mode line when a clock is running.
141 The function is called with point at the beginning of the headline."
142   :group 'org-clock
143   :type 'function)
144
145 (defcustom org-clock-string-limit 0
146   "Maximum length of clock strings in the modeline.  0 means no limit."
147   :group 'org-clock
148   :type 'integer)
149
150 (defcustom org-clock-in-resume nil
151   "If non-nil, resume clock when clocking into task with open clock.
152 When clocking into a task with a clock entry which has not been closed,
153 the clock can be resumed from that point."
154   :group 'org-clock
155   :type 'boolean)
156
157 (defcustom org-clock-persist nil
158   "When non-nil, save the running clock when Emacs is closed.
159 The clock is resumed when Emacs restarts.
160 When this is t, both the running clock, and the entire clock
161 history are saved.  When this is the symbol `clock', only the
162 running clock is saved.
163
164 When Emacs restarts with saved clock information, the file containing the
165 running clock as well as all files mentioned in the clock history will
166 be visited.
167 All this depends on running `org-clock-persistence-insinuate' in .emacs"
168   :group 'org-clock
169   :type '(choice
170           (const :tag "Just the running clock" clock)
171           (const :tag "Just the history" history)
172           (const :tag "Clock and history" t)
173           (const :tag "No persistence" nil)))
174
175 (defcustom org-clock-persist-file (convert-standard-filename
176                                    "~/.emacs.d/org-clock-save.el")
177   "File to save clock data to."
178   :group 'org-clock
179   :type 'string)
180
181 (defcustom org-clock-persist-query-save nil
182   "When non-nil, ask before saving the current clock on exit."
183   :group 'org-clock
184   :type 'boolean)
185
186 (defcustom org-clock-persist-query-resume t
187   "When non-nil, ask before resuming any stored clock during load."
188   :group 'org-clock
189   :type 'boolean)
190
191 (defcustom org-clock-sound nil
192   "Sound that will used for notifications.
193 Possible values:
194
195 nil        no sound played.
196 t          standard Emacs beep
197 file name  play this sound file.  If not possible, fall back to beep"
198   :group 'org-clock
199   :type '(choice
200           (const :tag "No sound" nil)
201           (const :tag "Standard beep" t)
202           (file :tag "Play sound file")))
203
204 (defcustom org-clock-modeline-total 'auto
205   "Default setting for the time included for the modeline clock.
206 This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
207 Allowed values are:
208
209 current  Only the time in the current instance of the clock
210 today    All time clocked into this task today
211 repeat   All time clocked into this task since last repeat
212 all      All time ever recorded for this task
213 auto     Automatically, either `all', or `repeat' for repeating tasks"
214   :group 'org-clock
215   :type '(choice
216           (const :tag "Current clock" current)
217           (const :tag "Today's task time" today)
218           (const :tag "Since last repeat" repeat)
219           (const :tag "All task time" all)
220           (const :tag "Automatically, `all' or since `repeat'" auto)))
221
222 (defcustom org-task-overrun-text nil
223   "The extra modeline text that should indicate that the clock is overrun.
224 The can be nil to indicate that instead of adding text, the clock time
225 should get a different face (`org-mode-line-clock-overrun').
226 When this is a string, it is prepended to the clock string as an indication,
227 also using the face `org-mode-line-clock-overrun'."
228   :group 'org-clock
229   :type '(choice
230           (const :tag "Just mark the time string" nil)
231           (string :tag "Text to prepend")))
232
233 (defcustom org-show-notification-handler nil
234   "Function or program to send notification with.
235 The function or program will be called with the notification
236 string as argument."
237   :group 'org-clock
238   :type '(choice
239           (string :tag "Program")
240           (function :tag "Function")))
241
242 (defgroup org-clocktable nil
243   "Options concerning the clock table in Org-mode."
244   :tag "Org Clock Table"
245   :group 'org-clock)
246
247 (defcustom org-clocktable-defaults
248   `(list
249     :maxlevel 2
250     :lang ,org-export-default-language
251     :scope 'file
252     :block nil
253     :tstart nil
254     :tend nil
255     :step nil
256     :stepskip0 nil
257     :fileskip0 nil
258     :tags nil
259     :emphasize nil
260     :link nil
261     :narrow '40!
262     :indent t
263     :formula nil
264     :timestamp nil
265     :level nil
266     :tcolumns nil
267     :formatter nil)
268   "Default properties for clock tables."
269   :group 'org-clock
270   :type 'plist)
271
272 (defcustom org-clock-clocktable-formatter 'org-clocktable-write-default
273   "Function to turn clocking data into a table.
274 For more information, see `org-clocktable-write-default'."
275   :group 'org-clocktable
276   :type 'function)
277
278 ;; FIXME: translate es and nl last string "Clock summary at"
279 (defcustom org-clock-clocktable-language-setup
280   '(("en" "File"     "L"  "Timestamp"  "Headline" "Time"  "ALL"   "Total time"   "File time" "Clock summary at")
281     ("es" "Archivo"  "N"  "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo" "Clock summary at")
282     ("fr" "Fichier"  "N"  "Horodatage" "En-tête"  "Durée" "TOUT"  "Durée totale" "Durée fichier" "Horodatage sommaire à")
283     ("nl" "Bestand"  "N"  "Tijdstip"   "Hoofding" "Duur"  "ALLES" "Totale duur"  "Bestandstijd" "Clock summary at"))
284   "Terms used in clocktable, translated to different languages."
285   :group 'org-clocktable
286   :type 'alist)
287
288 (defcustom org-clock-clocktable-default-properties '(:maxlevel 2 :scope file)
289   "Default properties for new clocktables.
290 These will be inserted into the BEGIN line, to make it easy for users to
291 play with them."
292   :group 'org-clocktable
293   :type 'plist)
294
295 (defcustom org-clock-idle-time nil
296   "When non-nil, resolve open clocks if the user is idle more than X minutes."
297   :group 'org-clock
298   :type '(choice
299           (const :tag "Never" nil)
300           (integer :tag "After N minutes")))
301
302 (defcustom org-clock-auto-clock-resolution 'when-no-clock-is-running
303   "When to automatically resolve open clocks found in Org buffers."
304   :group 'org-clock
305   :type '(choice
306           (const :tag "Never" nil)
307           (const :tag "Always" t)
308           (const :tag "When no clock is running" when-no-clock-is-running)))
309
310 (defcustom org-clock-report-include-clocking-task nil
311   "When non-nil, include the current clocking task time in clock reports."
312   :group 'org-clock
313   :type 'boolean)
314
315 (defcustom org-clock-resolve-expert nil
316   "Non-nil means do not show the splash buffer with the clock resolver."
317   :group 'org-clock
318   :type 'boolean)
319
320 (defvar org-clock-in-prepare-hook nil
321   "Hook run when preparing the clock.
322 This hook is run before anything happens to the task that
323 you want to clock in.  For example, you can use this hook
324 to add an effort property.")
325 (defvar org-clock-in-hook nil
326   "Hook run when starting the clock.")
327 (defvar org-clock-out-hook nil
328   "Hook run when stopping the current clock.")
329
330 (defvar org-clock-cancel-hook nil
331   "Hook run when cancelling the current clock.")
332 (defvar org-clock-goto-hook nil
333   "Hook run when selecting the currently clocked-in entry.")
334 (defvar org-clock-has-been-used nil
335   "Has the clock been used during the current Emacs session?")
336
337 ;;; The clock for measuring work time.
338
339 (defvar org-mode-line-string "")
340 (put 'org-mode-line-string 'risky-local-variable t)
341
342 (defvar org-clock-mode-line-timer nil)
343 (defvar org-clock-idle-timer nil)
344 (defvar org-clock-heading) ; defined in org.el
345 (defvar org-clock-heading-for-remember "")
346 (defvar org-clock-start-time "")
347
348 (defvar org-clock-leftover-time nil
349   "If non-nil, user cancelled a clock; this is when leftover time started.")
350
351 (defvar org-clock-effort ""
352   "Effort estimate of the currently clocking task.")
353
354 (defvar org-clock-total-time nil
355   "Holds total time, spent previously on currently clocked item.
356 This does not include the time in the currently running clock.")
357
358 (defvar org-clock-history nil
359   "List of marker pointing to recent clocked tasks.")
360
361 (defvar org-clock-default-task (make-marker)
362   "Marker pointing to the default task that should clock time.
363 The clock can be made to switch to this task after clocking out
364 of a different task.")
365
366 (defvar org-clock-interrupted-task (make-marker)
367   "Marker pointing to the task that has been interrupted by the current clock.")
368
369 (defvar org-clock-mode-line-map (make-sparse-keymap))
370 (define-key org-clock-mode-line-map [mode-line mouse-2] 'org-clock-goto)
371 (define-key org-clock-mode-line-map [mode-line mouse-1] 'org-clock-menu)
372
373 (defun org-clock-menu ()
374   (interactive)
375   (popup-menu
376    '("Clock"
377      ["Clock out" org-clock-out t]
378      ["Change effort estimate" org-clock-modify-effort-estimate t]
379      ["Go to clock entry" org-clock-goto t]
380      ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"])))
381
382 (defun org-clock-history-push (&optional pos buffer)
383   "Push a marker to the clock history."
384   (setq org-clock-history-length (max 1 (min 35 org-clock-history-length)))
385   (let ((m (move-marker (make-marker)
386                         (or pos (point)) (org-base-buffer
387                                           (or buffer (current-buffer)))))
388         n l)
389     (while (setq n (member m org-clock-history))
390       (move-marker (car n) nil))
391     (setq org-clock-history
392           (delq nil
393                 (mapcar (lambda (x) (if (marker-buffer x) x nil))
394                         org-clock-history)))
395     (when (>= (setq l (length org-clock-history)) org-clock-history-length)
396       (setq org-clock-history
397             (nreverse
398              (nthcdr (- l org-clock-history-length -1)
399                      (nreverse org-clock-history)))))
400     (push m org-clock-history)))
401
402 (defun org-clock-save-markers-for-cut-and-paste (beg end)
403   "Save relative positions of markers in region."
404   (org-check-and-save-marker org-clock-marker beg end)
405   (org-check-and-save-marker org-clock-hd-marker beg end)
406   (org-check-and-save-marker org-clock-default-task beg end)
407   (org-check-and-save-marker org-clock-interrupted-task beg end)
408   (mapc (lambda (m) (org-check-and-save-marker m beg end))
409         org-clock-history))
410
411 (defun org-clocking-buffer ()
412   "Return the clocking buffer if we are currently clocking a task or nil."
413   (marker-buffer org-clock-marker))
414
415 (defun org-clocking-p ()
416   "Return t when clocking a task."
417   (not (equal (org-clocking-buffer) nil)))
418
419 (defvar org-clock-before-select-task-hook nil
420   "Hook called in task selection just before prompting the user.")
421
422 (defun org-clock-select-task (&optional prompt)
423   "Select a task that recently was associated with clocking."
424   (interactive)
425   (let (sel-list rpl (i 0) s)
426     (save-window-excursion
427       (org-switch-to-buffer-other-window
428        (get-buffer-create "*Clock Task Select*"))
429       (erase-buffer)
430       (when (marker-buffer org-clock-default-task)
431         (insert (org-add-props "Default Task\n" nil 'face 'bold))
432         (setq s (org-clock-insert-selection-line ?d org-clock-default-task))
433         (push s sel-list))
434       (when (marker-buffer org-clock-interrupted-task)
435         (insert (org-add-props "The task interrupted by starting the last one\n" nil 'face 'bold))
436         (setq s (org-clock-insert-selection-line ?i org-clock-interrupted-task))
437         (push s sel-list))
438       (when (org-clocking-p)
439         (insert (org-add-props "Current Clocking Task\n" nil 'face 'bold))
440         (setq s (org-clock-insert-selection-line ?c org-clock-marker))
441         (push s sel-list))
442       (insert (org-add-props "Recent Tasks\n" nil 'face 'bold))
443       (mapc
444        (lambda (m)
445          (when (marker-buffer m)
446            (setq i (1+ i)
447                  s (org-clock-insert-selection-line
448                     (if (< i 10)
449                         (+ i ?0)
450                       (+ i (- ?A 10))) m))
451            (if (fboundp 'int-to-char) (setf (car s) (int-to-char (car s))))
452            (push s sel-list)))
453        org-clock-history)
454       (run-hooks 'org-clock-before-select-task-hook)
455       (org-fit-window-to-buffer)
456       (message (or prompt "Select task for clocking:"))
457       (setq rpl (read-char-exclusive))
458       (cond
459        ((eq rpl ?q) nil)
460        ((eq rpl ?x) nil)
461        ((assoc rpl sel-list) (cdr (assoc rpl sel-list)))
462        (t (error "Invalid task choice %c" rpl))))))
463
464 (defun org-clock-insert-selection-line (i marker)
465   "Insert a line for the clock selection menu.
466 And return a cons cell with the selection character integer and the marker
467 pointing to it."
468   (when (marker-buffer marker)
469     (let (file cat task heading prefix)
470       (with-current-buffer (org-base-buffer (marker-buffer marker))
471         (save-excursion
472           (save-restriction
473             (widen)
474             (ignore-errors
475               (goto-char marker)
476               (setq file (buffer-file-name (marker-buffer marker))
477                     cat (org-get-category)
478                     heading (org-get-heading 'notags)
479                     prefix (save-excursion
480                              (org-back-to-heading t)
481                              (looking-at "\\*+ ")
482                              (match-string 0))
483                     task (substring
484                           (org-fontify-like-in-org-mode
485                            (concat prefix heading)
486                            org-odd-levels-only)
487                           (length prefix)))))))
488       (when (and cat task)
489         (insert (format "[%c] %-15s %s\n" i cat task))
490         (cons i marker)))))
491
492 (defvar org-task-overrun nil
493   "Internal flag indicating if the clock has overrun the planned time.")
494 (defvar org-clock-update-period 60
495   "Number of seconds between mode line clock string updates.")
496
497 (defun org-clock-get-clock-string ()
498   "Form a clock-string, that will be shown in the mode line.
499 If an effort estimate was defined for the current item, use
500 01:30/01:50 format (clocked/estimated).
501 If not, show simply the clocked time like 01:50."
502   (let* ((clocked-time (org-clock-get-clocked-time))
503          (h (floor clocked-time 60))
504          (m (- clocked-time (* 60 h))))
505     (if org-clock-effort
506         (let* ((effort-in-minutes
507                 (org-duration-string-to-minutes org-clock-effort))
508                (effort-h (floor effort-in-minutes 60))
509                (effort-m (- effort-in-minutes (* effort-h 60)))
510                (work-done-str
511                 (org-propertize
512                  (format org-time-clocksum-format h m)
513                  'face (if (and org-task-overrun (not org-task-overrun-text))
514                            'org-mode-line-clock-overrun 'org-mode-line-clock)))
515                (effort-str (format org-time-clocksum-format effort-h effort-m))
516                (clockstr (org-propertize
517                           (concat  "[%s/" effort-str
518                                    "] (" (replace-regexp-in-string "%" "%%" org-clock-heading) ")")
519                           'face 'org-mode-line-clock)))
520           (format clockstr work-done-str))
521       (org-propertize (format
522                        (concat "[" org-time-clocksum-format " (%s)]")
523                        h m org-clock-heading)
524                       'face 'org-mode-line-clock))))
525
526 (defun org-clock-update-mode-line ()
527   (if org-clock-effort
528       (org-clock-notify-once-if-expired)
529     (setq org-task-overrun nil))
530   (setq org-mode-line-string
531         (org-propertize
532          (let ((clock-string (org-clock-get-clock-string))
533                (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
534            (if (and (> org-clock-string-limit 0)
535                     (> (length clock-string) org-clock-string-limit))
536                (org-propertize
537                 (substring clock-string 0 org-clock-string-limit)
538                 'help-echo (concat help-text ": " org-clock-heading))
539              (org-propertize clock-string 'help-echo help-text)))
540          'local-map org-clock-mode-line-map
541          'mouse-face (if (featurep 'xemacs) 'highlight 'mode-line-highlight)
542          ))
543   (if (and org-task-overrun org-task-overrun-text)
544       (setq org-mode-line-string
545             (concat (org-propertize
546                      org-task-overrun-text
547                      'face 'org-mode-line-clock-overrun) org-mode-line-string)))
548   (force-mode-line-update))
549
550 (defun org-clock-get-clocked-time ()
551   "Get the clocked time for the current item in minutes.
552 The time returned includes the time spent on this task in
553 previous clocking intervals."
554   (let ((currently-clocked-time
555          (floor (- (org-float-time)
556                    (org-float-time org-clock-start-time)) 60)))
557     (+ currently-clocked-time (or org-clock-total-time 0))))
558
559 (defun org-clock-modify-effort-estimate (&optional value)
560  "Add to or set the effort estimate of the item currently being clocked.
561 VALUE can be a number of minutes, or a string with format hh:mm or mm.
562 When the string starts with a + or a - sign, the current value of the effort
563 property will be changed by that amount.
564 This will update the \"Effort\" property of currently clocked item, and
565 the mode line."
566  (interactive)
567  (when (org-clock-is-active)
568    (let ((current org-clock-effort) sign)
569      (unless value
570        ;; Prompt user for a value or a change
571        (setq value
572              (read-string
573               (format "Set effort (hh:mm or mm%s): "
574                       (if current
575                           (format ", prefix + to add to %s" org-clock-effort)
576                         "")))))
577      (when (stringp value)
578        ;; A string.  See if it is a delta
579        (setq sign (string-to-char value))
580        (if (member sign '(?- ?+))
581            (setq current (org-duration-string-to-minutes current)
582                  value (substring value 1))
583          (setq current 0))
584        (setq value (org-duration-string-to-minutes value))
585        (if (equal ?- sign)
586            (setq value (- current value))
587          (if (equal ?+ sign) (setq value (+ current value)))))
588      (setq value (max 0 value)
589            org-clock-effort (org-minutes-to-hh:mm-string value))
590      (org-entry-put org-clock-marker "Effort" org-clock-effort)
591      (org-clock-update-mode-line)
592      (message "Effort is now %s" org-clock-effort))))
593
594 (defvar org-clock-notification-was-shown nil
595   "Shows if we have shown notification already.")
596
597 (defun org-clock-notify-once-if-expired ()
598   "Show notification if we spent more time than we estimated before.
599 Notification is shown only once."
600   (when (org-clocking-p)
601     (let ((effort-in-minutes (org-duration-string-to-minutes org-clock-effort))
602           (clocked-time (org-clock-get-clocked-time)))
603       (if (setq org-task-overrun
604                 (if (or (null effort-in-minutes) (zerop effort-in-minutes))
605                     nil
606                   (>= clocked-time effort-in-minutes)))
607           (unless org-clock-notification-was-shown
608             (setq org-clock-notification-was-shown t)
609             (org-notify
610              (format "Task '%s' should be finished by now. (%s)"
611                      org-clock-heading org-clock-effort) t))
612         (setq org-clock-notification-was-shown nil)))))
613
614 (defun org-notify (notification &optional play-sound)
615   "Send a NOTIFICATION and maybe PLAY-SOUND."
616   (org-show-notification notification)
617   (if play-sound (org-clock-play-sound)))
618
619 (defun org-show-notification (notification)
620   "Show notification.
621 Use `org-show-notification-handler' if defined,
622 use libnotify if available, or fall back on a message."
623   (cond ((functionp org-show-notification-handler)
624          (funcall org-show-notification-handler notification))
625         ((stringp org-show-notification-handler)
626          (start-process "emacs-timer-notification" nil
627                         org-show-notification-handler notification))
628         ((featurep 'notifications)
629          (require 'notifications)
630          (notifications-notify
631           :title "Org-mode message"
632           :body notification
633           ;; FIXME how to link to the Org icon?
634           ;; :app-icon "~/.emacs.d/icons/mail.png"
635           :urgency 'low))
636         ((org-program-exists "notify-send")
637          (start-process "emacs-timer-notification" nil
638                         "notify-send" notification))
639         ;; Maybe the handler will send a message, so only use message as
640         ;; a fall back option
641         (t (message "%s" notification))))
642
643 (defun org-clock-play-sound ()
644   "Play sound as configured by `org-clock-sound'.
645 Use alsa's aplay tool if available."
646   (cond
647    ((not org-clock-sound))
648    ((eq org-clock-sound t) (beep t) (beep t))
649    ((stringp org-clock-sound)
650     (let ((file (expand-file-name org-clock-sound)))
651       (if (file-exists-p file)
652           (if (org-program-exists "aplay")
653               (start-process "org-clock-play-notification" nil
654                              "aplay" file)
655             (condition-case nil
656                 (play-sound-file file)
657               (error (beep t) (beep t)))))))))
658
659 (defun org-program-exists (program-name)
660   "Checks whenever we can locate program and launch it."
661   (if (eq system-type 'gnu/linux)
662       (= 0 (call-process "which" nil nil nil program-name))))
663
664 (defvar org-clock-mode-line-entry nil
665   "Information for the modeline about the running clock.")
666
667 (defun org-find-open-clocks (file)
668   "Search through the given file and find all open clocks."
669   (let ((buf (or (get-file-buffer file)
670                  (find-file-noselect file)))
671         clocks)
672     (with-current-buffer buf
673       (save-excursion
674         (goto-char (point-min))
675         (while (re-search-forward "CLOCK: \\(\\[.*?\\]\\)$" nil t)
676           (push (cons (copy-marker (match-end 1) t)
677                       (org-time-string-to-time (match-string 1))) clocks))))
678     clocks))
679
680 (defsubst org-is-active-clock (clock)
681   "Return t if CLOCK is the currently active clock."
682   (and (org-clock-is-active)
683        (= org-clock-marker (car clock))))
684
685 (defmacro org-with-clock-position (clock &rest forms)
686   "Evaluate FORMS with CLOCK as the current active clock."
687   `(with-current-buffer (marker-buffer (car ,clock))
688      (save-excursion
689        (save-restriction
690          (widen)
691          (goto-char (car ,clock))
692          (beginning-of-line)
693          ,@forms))))
694
695 (put 'org-with-clock-position 'lisp-indent-function 1)
696
697 (defmacro org-with-clock (clock &rest forms)
698   "Evaluate FORMS with CLOCK as the current active clock.
699 This macro also protects the current active clock from being altered."
700   `(org-with-clock-position ,clock
701      (let ((org-clock-start-time (cdr ,clock))
702            (org-clock-total-time)
703            (org-clock-history)
704            (org-clock-effort)
705            (org-clock-marker (car ,clock))
706            (org-clock-hd-marker (save-excursion
707                                   (outline-back-to-heading t)
708                                   (point-marker))))
709        ,@forms)))
710
711 (put 'org-with-clock 'lisp-indent-function 1)
712
713 (defsubst org-clock-clock-in (clock &optional resume start-time)
714   "Clock in to the clock located by CLOCK.
715 If necessary, clock-out of the currently active clock."
716   (org-with-clock-position clock
717     (let ((org-clock-in-resume (or resume org-clock-in-resume)))
718       (org-clock-in nil start-time))))
719
720 (defsubst org-clock-clock-out (clock &optional fail-quietly at-time)
721   "Clock out of the clock located by CLOCK."
722   (let ((temp (copy-marker (car clock)
723                            (marker-insertion-type (car clock)))))
724     (if (org-is-active-clock clock)
725         (org-clock-out fail-quietly at-time)
726       (org-with-clock clock
727         (org-clock-out fail-quietly at-time)))
728     (setcar clock temp)))
729
730 (defsubst org-clock-clock-cancel (clock)
731   "Cancel the clock located by CLOCK."
732   (let ((temp (copy-marker (car clock)
733                            (marker-insertion-type (car clock)))))
734     (if (org-is-active-clock clock)
735         (org-clock-cancel)
736       (org-with-clock clock
737         (org-clock-cancel)))
738     (setcar clock temp)))
739
740 (defvar org-clock-clocking-in nil)
741 (defvar org-clock-resolving-clocks nil)
742 (defvar org-clock-resolving-clocks-due-to-idleness nil)
743
744 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
745                                       &optional close-p restart-p fail-quietly)
746   "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
747 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
748   (let ((org-clock-resolving-clocks t))
749     (cond
750      ((null resolve-to)
751       (org-clock-clock-cancel clock)
752       (if (and restart-p (not org-clock-clocking-in))
753           (org-clock-clock-in clock)))
754
755      ((eq resolve-to 'now)
756       (if restart-p
757           (error "RESTART-P is not valid here"))
758       (if (or close-p org-clock-clocking-in)
759           (org-clock-clock-out clock fail-quietly)
760         (unless (org-is-active-clock clock)
761           (org-clock-clock-in clock t))))
762
763      ((not (time-less-p resolve-to (current-time)))
764       (error "RESOLVE-TO must refer to a time in the past"))
765
766      (t
767       (if restart-p
768           (error "RESTART-P is not valid here"))
769       (org-clock-clock-out clock fail-quietly (or clock-out-time
770                                                   resolve-to))
771       (unless org-clock-clocking-in
772         (if close-p
773             (setq org-clock-leftover-time (and (null clock-out-time)
774                                                resolve-to))
775           (org-clock-clock-in clock nil (and clock-out-time
776                                              resolve-to))))))))
777
778 (defun org-clock-jump-to-current-clock (&optional effective-clock)
779   (interactive)
780   (let ((org-clock-into-drawer (org-clock-into-drawer))
781         (clock (or effective-clock (cons org-clock-marker
782                                          org-clock-start-time))))
783     (unless (marker-buffer (car clock))
784       (error "No clock is currently running"))
785     (org-with-clock clock (org-clock-goto))
786     (with-current-buffer (marker-buffer (car clock))
787       (goto-char (car clock))
788       (if org-clock-into-drawer
789           (let ((logbook
790                  (if (stringp org-clock-into-drawer)
791                      (concat ":" org-clock-into-drawer ":")
792                    ":LOGBOOK:")))
793             (ignore-errors
794               (outline-flag-region
795                (save-excursion
796                  (outline-back-to-heading t)
797                  (search-forward logbook)
798                  (goto-char (match-beginning 0)))
799                (save-excursion
800                  (outline-back-to-heading t)
801                  (search-forward logbook)
802                  (search-forward ":END:")
803                  (goto-char (match-end 0)))
804                nil)))))))
805
806 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly)
807   "Resolve an open org-mode clock.
808 An open clock was found, with `dangling' possibly being non-nil.
809 If this function was invoked with a prefix argument, non-dangling
810 open clocks are ignored.  The given clock requires some sort of
811 user intervention to resolve it, either because a clock was left
812 dangling or due to an idle timeout.  The clock resolution can
813 either be:
814
815   (a) deleted, the user doesn't care about the clock
816   (b) restarted from the current time (if no other clock is open)
817   (c) closed, giving the clock X minutes
818   (d) closed and then restarted
819   (e) resumed, as if the user had never left
820
821 The format of clock is (CONS MARKER START-TIME), where MARKER
822 identifies the buffer and position the clock is open at (and
823 thus, the heading it's under), and START-TIME is when the clock
824 was started."
825   (assert clock)
826   (let* ((ch
827           (save-window-excursion
828             (save-excursion
829               (unless org-clock-resolving-clocks-due-to-idleness
830                 (org-clock-jump-to-current-clock clock))
831               (unless org-clock-resolve-expert
832                 (with-output-to-temp-buffer "*Org Clock*"
833                   (princ "Select a Clock Resolution Command:
834
835 i/q/C-g  Ignore this question; the same as keeping all the idle time.
836
837 k/K      Keep X minutes of the idle time (default is all).  If this
838          amount is less than the default, you will be clocked out
839          that many minutes after the time that idling began, and then
840          clocked back in at the present time.
841 g/G      Indicate that you \"got back\" X minutes ago.  This is quite
842          different from 'k': it clocks you out from the beginning of
843          the idle period and clock you back in X minutes ago.
844 s/S      Subtract the idle time from the current clock.  This is the
845          same as keeping 0 minutes.
846 C        Cancel the open timer altogether.  It will be as though you
847          never clocked in.
848 j/J      Jump to the current clock, to make manual adjustments.
849
850 For all these options, using uppercase makes your final state
851 to be CLOCKED OUT.")))
852               (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
853               (let (char-pressed)
854                 (when (featurep 'xemacs)
855                   (message (concat (funcall prompt-fn clock)
856                                    " [jkKgGsScCiq]? "))
857                   (setq char-pressed (read-char-exclusive)))
858                 (while (or (null char-pressed)
859                            (and (not (memq char-pressed
860                                            '(?k ?K ?g ?G ?s ?S ?C
861                                                 ?j ?J ?i ?q)))
862                                 (or (ding) t)))
863                   (setq char-pressed
864                         (read-char (concat (funcall prompt-fn clock)
865                                            " [jkKgGSscCiq]? ")
866                                    nil 45)))
867                 (and (not (memq char-pressed '(?i ?q))) char-pressed)))))
868          (default
869            (floor (/ (org-float-time
870                       (time-subtract (current-time) last-valid)) 60)))
871          (keep
872           (and (memq ch '(?k ?K))
873                (read-number "Keep how many minutes? " default)))
874          (gotback
875           (and (memq ch '(?g ?G))
876                (read-number "Got back how many minutes ago? " default)))
877          (subtractp (memq ch '(?s ?S)))
878          (barely-started-p (< (- (org-float-time last-valid)
879                                  (org-float-time (cdr clock))) 45))
880          (start-over (and subtractp barely-started-p)))
881     (cond
882      ((memq ch '(?j ?J))
883       (if (eq ch ?J)
884           (org-clock-resolve-clock clock 'now nil t nil fail-quietly))
885       (org-clock-jump-to-current-clock clock))
886      ((or (null ch)
887           (not (memq ch '(?k ?K ?g ?G ?s ?S ?C))))
888       (message ""))
889      (t
890       (org-clock-resolve-clock
891        clock (cond
892               ((or (eq ch ?C)
893                    ;; If the time on the clock was less than a minute before
894                    ;; the user went away, and they've ask to subtract all the
895                    ;; time...
896                    start-over)
897                nil)
898               ((or subtractp
899                    (and gotback (= gotback 0)))
900                last-valid)
901               ((or (and keep (= keep default))
902                    (and gotback (= gotback default)))
903                'now)
904               (keep
905                (time-add last-valid (seconds-to-time (* 60 keep))))
906               (gotback
907                (time-subtract (current-time)
908                               (seconds-to-time (* 60 gotback))))
909               (t
910                (error "Unexpected, please report this as a bug")))
911        (and gotback last-valid)
912        (memq ch '(?K ?G ?S))
913        (and start-over
914             (not (memq ch '(?K ?G ?S ?C))))
915        fail-quietly)))))
916
917 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid)
918   "Resolve all currently open org-mode clocks.
919 If `only-dangling-p' is non-nil, only ask to resolve dangling
920 \(i.e., not currently open and valid) clocks."
921   (interactive "P")
922   (unless org-clock-resolving-clocks
923     (let ((org-clock-resolving-clocks t))
924       (dolist (file (org-files-list))
925         (let ((clocks (org-find-open-clocks file)))
926           (dolist (clock clocks)
927             (let ((dangling (or (not (org-clock-is-active))
928                                 (/= (car clock) org-clock-marker))))
929               (if (or (not only-dangling-p) dangling)
930                 (org-clock-resolve
931                  clock
932                  (or prompt-fn
933                      (function
934                       (lambda (clock)
935                         (format
936                          "Dangling clock started %d mins ago"
937                          (floor
938                           (/ (- (org-float-time (current-time))
939                                 (org-float-time (cdr clock))) 60))))))
940                  (or last-valid
941                      (cdr clock)))))))))))
942
943 (defun org-emacs-idle-seconds ()
944   "Return the current Emacs idle time in seconds, or nil if not idle."
945   (let ((idle-time (current-idle-time)))
946     (if idle-time
947         (org-float-time idle-time)
948       0)))
949
950 (defun org-mac-idle-seconds ()
951   "Return the current Mac idle time in seconds."
952   (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
953
954 (defun org-x11-idle-seconds ()
955   "Return the current X11 idle time in seconds."
956   (/ (string-to-number (shell-command-to-string "x11idle")) 1000))
957
958 (defun org-user-idle-seconds ()
959   "Return the number of seconds the user has been idle for.
960 This routine returns a floating point number."
961   (cond
962    ((eq system-type 'darwin)
963     (org-mac-idle-seconds))
964    ((eq window-system 'x)
965     (org-x11-idle-seconds))
966    (t
967     (org-emacs-idle-seconds))))
968
969 (defvar org-clock-user-idle-seconds)
970
971 (defun org-resolve-clocks-if-idle ()
972   "Resolve all currently open org-mode clocks.
973 This is performed after `org-clock-idle-time' minutes, to check
974 if the user really wants to stay clocked in after being idle for
975 so long."
976   (when (and org-clock-idle-time (not org-clock-resolving-clocks)
977              org-clock-marker)
978     (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
979            (org-clock-user-idle-start
980             (time-subtract (current-time)
981                            (seconds-to-time org-clock-user-idle-seconds)))
982            (org-clock-resolving-clocks-due-to-idleness t))
983       (if (> org-clock-user-idle-seconds (* 60 org-clock-idle-time))
984           (org-clock-resolve
985            (cons org-clock-marker
986                  org-clock-start-time)
987            (function
988             (lambda (clock)
989               (format "Clocked in & idle for %.1f mins"
990                       (/ (org-float-time
991                           (time-subtract (current-time)
992                                          org-clock-user-idle-start))
993                          60.0))))
994            org-clock-user-idle-start)))))
995
996 (defvar org-clock-current-task nil
997   "Task currently clocked in.")
998 (defun org-clock-set-current ()
999   "Set `org-clock-current-task' to the task currently clocked in."
1000   (setq org-clock-current-task (nth 4 (org-heading-components))))
1001
1002 (defun org-clock-delete-current ()
1003   "Reset `org-clock-current-task' to nil."
1004   (setq org-clock-current-task nil))
1005
1006 (defun org-clock-in (&optional select start-time)
1007   "Start the clock on the current item.
1008 If necessary, clock-out of the currently active clock.
1009 With a prefix argument SELECT (\\[universal-argument]), offer a list of \
1010 recently clocked tasks to
1011 clock into.  When SELECT is \\[universal-argument] \\[universal-argument], \
1012 clock into the current task and mark
1013 is as the default task, a special task that will always be offered in
1014 the clocking selection, associated with the letter `d'."
1015   (interactive "P")
1016   (setq org-clock-notification-was-shown nil)
1017   (catch 'abort
1018     (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness)
1019                              (org-clocking-p)))
1020           ts selected-task target-pos (msg-extra "")
1021           (leftover (and (not org-clock-resolving-clocks)
1022                           org-clock-leftover-time)))
1023
1024       (when (and org-clock-auto-clock-resolution
1025                  (or (not interrupting)
1026                      (eq t org-clock-auto-clock-resolution))
1027                  (not org-clock-clocking-in)
1028                  (not org-clock-resolving-clocks))
1029         (setq org-clock-leftover-time nil)
1030         (let ((org-clock-clocking-in t))
1031           (org-resolve-clocks)))        ; check if any clocks are dangling
1032
1033       (when (equal select '(4))
1034         (setq selected-task (org-clock-select-task "Clock-in on task: "))
1035         (if selected-task
1036             (setq selected-task (copy-marker selected-task))
1037           (error "Abort")))
1038
1039       (when (equal select '(16))
1040         ;; Mark as default clocking task
1041         (org-clock-mark-default-task))
1042
1043       (when interrupting
1044         ;; We are interrupting the clocking of a different task.
1045         ;; Save a marker to this task, so that we can go back.
1046         ;; First check if we are trying to clock into the same task!
1047         (when (save-excursion
1048                 (unless selected-task
1049                   (org-back-to-heading t))
1050                 (and (equal (marker-buffer org-clock-hd-marker)
1051                             (if selected-task
1052                                 (marker-buffer selected-task)
1053                               (current-buffer)))
1054                      (= (marker-position org-clock-hd-marker)
1055                         (if selected-task
1056                             (marker-position selected-task)
1057                           (point)))
1058                      (equal org-clock-current-task (nth 4 (org-heading-components)))))
1059           (message "Clock continues in \"%s\"" org-clock-heading)
1060           (throw 'abort nil))
1061         (move-marker org-clock-interrupted-task
1062                      (marker-position org-clock-marker)
1063                      (marker-buffer org-clock-marker))
1064         (let ((org-clock-clocking-in t))
1065           (org-clock-out t)))
1066
1067       ;; Clock in at which position?
1068       (setq target-pos
1069             (if (and (eobp) (not (org-on-heading-p)))
1070                 (point-at-bol 0)
1071               (point)))
1072       (run-hooks 'org-clock-in-prepare-hook)
1073       (save-excursion
1074         (when (and selected-task (marker-buffer selected-task))
1075           ;; There is a selected task, move to the correct buffer
1076           ;; and set the new target position.
1077           (set-buffer (org-base-buffer (marker-buffer selected-task)))
1078           (setq target-pos (marker-position selected-task))
1079           (move-marker selected-task nil))
1080         (save-excursion
1081           (save-restriction
1082             (widen)
1083             (goto-char target-pos)
1084             (org-back-to-heading t)
1085             (or interrupting (move-marker org-clock-interrupted-task nil))
1086             (org-clock-history-push)
1087             (org-clock-set-current)
1088             (cond ((functionp org-clock-in-switch-to-state)
1089                    (looking-at org-complex-heading-regexp)
1090                    (let ((newstate (funcall org-clock-in-switch-to-state
1091                                             (match-string 2))))
1092                      (if newstate (org-todo newstate))))
1093                   ((and org-clock-in-switch-to-state
1094                         (not (looking-at (concat outline-regexp "[ \t]*"
1095                                                  org-clock-in-switch-to-state
1096                                                  "\\>"))))
1097                    (org-todo org-clock-in-switch-to-state)))
1098             (setq org-clock-heading-for-remember
1099                   (and (looking-at org-complex-heading-regexp)
1100                        (match-end 4)
1101                        (org-trim (buffer-substring (match-end 1)
1102                                                    (match-end 4)))))
1103             (setq org-clock-heading
1104                   (cond ((and org-clock-heading-function
1105                               (functionp org-clock-heading-function))
1106                          (funcall org-clock-heading-function))
1107                         ((looking-at org-complex-heading-regexp)
1108                          (replace-regexp-in-string
1109                           "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1110                           (match-string 4)))
1111                         (t "???")))
1112             (setq org-clock-heading (org-propertize org-clock-heading
1113                                                     'face nil))
1114             (org-clock-find-position org-clock-in-resume)
1115             (cond
1116              ((and org-clock-in-resume
1117                    (looking-at
1118                     (concat "^[ \t]* " org-clock-string
1119                             " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1120                             " +\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1121               (message "Matched %s" (match-string 1))
1122               (setq ts (concat "[" (match-string 1) "]"))
1123               (goto-char (match-end 1))
1124               (setq org-clock-start-time
1125                     (apply 'encode-time
1126                            (org-parse-time-string (match-string 1))))
1127               (setq org-clock-effort (org-get-effort))
1128               (setq org-clock-total-time (org-clock-sum-current-item
1129                                           (org-clock-get-sum-start))))
1130              ((eq org-clock-in-resume 'auto-restart)
1131               ;; called from org-clock-load during startup,
1132               ;; do not interrupt, but warn!
1133               (message "Cannot restart clock because task does not contain unfinished clock")
1134               (ding)
1135               (sit-for 2)
1136               (throw 'abort nil))
1137              (t
1138               (insert-before-markers "\n")
1139               (backward-char 1)
1140               (org-indent-line-function)
1141               (when (and (save-excursion
1142                            (end-of-line 0)
1143                            (org-in-item-p)))
1144                 (beginning-of-line 1)
1145                 (org-indent-line-to (- (org-get-indentation) 2)))
1146               (insert org-clock-string " ")
1147               (setq org-clock-effort (org-get-effort))
1148               (setq org-clock-total-time (org-clock-sum-current-item
1149                                           (org-clock-get-sum-start)))
1150               (setq org-clock-start-time
1151                     (or (and leftover
1152                              (y-or-n-p
1153                               (format
1154                                "You stopped another clock %d mins ago; start this one from then? "
1155                                (/ (- (org-float-time (current-time))
1156                                      (org-float-time leftover)) 60)))
1157                              leftover)
1158                         start-time
1159                         (current-time)))
1160               (setq ts (org-insert-time-stamp org-clock-start-time
1161                                               'with-hm 'inactive))))
1162             (move-marker org-clock-marker (point) (buffer-base-buffer))
1163             (move-marker org-clock-hd-marker
1164                          (save-excursion (org-back-to-heading t) (point))
1165                          (buffer-base-buffer))
1166             (setq org-clock-has-been-used t)
1167             (or global-mode-string (setq global-mode-string '("")))
1168             (or (memq 'org-mode-line-string global-mode-string)
1169                 (setq global-mode-string
1170                       (append global-mode-string '(org-mode-line-string))))
1171             (org-clock-update-mode-line)
1172             (when org-clock-mode-line-timer
1173               (cancel-timer org-clock-mode-line-timer)
1174               (setq org-clock-mode-line-timer nil))
1175             (setq org-clock-mode-line-timer
1176                   (run-with-timer org-clock-update-period
1177                                   org-clock-update-period
1178                                   'org-clock-update-mode-line))
1179             (when org-clock-idle-timer
1180               (cancel-timer org-clock-idle-timer)
1181               (setq org-clock-idle-timer nil))
1182             (setq org-clock-idle-timer
1183                   (run-with-timer 60 60 'org-resolve-clocks-if-idle))
1184             (message "Clock starts at %s - %s" ts msg-extra)
1185             (run-hooks 'org-clock-in-hook)))))))
1186
1187 (defun org-clock-mark-default-task ()
1188   "Mark current task as default task."
1189   (interactive)
1190   (save-excursion
1191     (org-back-to-heading t)
1192     (move-marker org-clock-default-task (point))))
1193
1194 (defvar msg-extra)
1195 (defun org-clock-get-sum-start ()
1196   "Return the time from which clock times should be counted.
1197 This is for the currently running clock as it is displayed
1198 in the mode line.  This function looks at the properties
1199 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
1200 corresponding variable `org-clock-modeline-total' and then
1201 decides which time to use."
1202   (let ((cmt (or (org-entry-get nil "CLOCK_MODELINE_TOTAL")
1203                  (symbol-name org-clock-modeline-total)))
1204         (lr (org-entry-get nil "LAST_REPEAT")))
1205     (cond
1206      ((equal cmt "current")
1207       (setq msg-extra "showing time in current clock instance")
1208       (current-time))
1209      ((equal cmt "today")
1210       (setq msg-extra "showing today's task time.")
1211       (let* ((dt (decode-time (current-time))))
1212         (setq dt (append (list 0 0 0) (nthcdr 3 dt)))
1213         (if org-extend-today-until
1214             (setf (nth 2 dt) org-extend-today-until))
1215         (apply 'encode-time dt)))
1216      ((or (equal cmt "all")
1217           (and (or (not cmt) (equal cmt "auto"))
1218                (not lr)))
1219       (setq msg-extra "showing entire task time.")
1220       nil)
1221      ((or (equal cmt "repeat")
1222           (and (or (not cmt) (equal cmt "auto"))
1223                lr))
1224       (setq msg-extra "showing task time since last repeat.")
1225       (if (not lr)
1226           nil
1227         (org-time-string-to-time lr)))
1228      (t nil))))
1229
1230 (defun org-clock-find-position (find-unclosed)
1231   "Find the location where the next clock line should be inserted.
1232 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1233 line and position cursor in that line."
1234   (org-back-to-heading t)
1235   (catch 'exit
1236     (let* ((org-clock-into-drawer (org-clock-into-drawer))
1237            (beg (save-excursion
1238                   (beginning-of-line 2)
1239                   (or (bolp) (newline))
1240                   (point)))
1241            (end (progn (outline-next-heading) (point)))
1242            (re (concat "^[ \t]*" org-clock-string))
1243            (cnt 0)
1244            (drawer (if (stringp org-clock-into-drawer)
1245                        org-clock-into-drawer "LOGBOOK"))
1246            first last ind-last)
1247       (goto-char beg)
1248       (when (and find-unclosed
1249                  (re-search-forward
1250                   (concat "^[ \t]* " org-clock-string
1251                           " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1252                           " +\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")
1253                   end t))
1254         (beginning-of-line 1)
1255         (throw 'exit t))
1256       (when (eobp) (newline) (setq end (max (point) end)))
1257       (when (re-search-forward (concat "^[ \t]*:" drawer ":") end t)
1258         ;; we seem to have a CLOCK drawer, so go there.
1259         (beginning-of-line 2)
1260         (or org-log-states-order-reversed
1261             (and (re-search-forward org-property-end-re nil t)
1262                  (goto-char (match-beginning 0))))
1263         (throw 'exit t))
1264       ;; Lets count the CLOCK lines
1265       (goto-char beg)
1266       (while (re-search-forward re end t)
1267         (setq first (or first (match-beginning 0))
1268               last (match-beginning 0)
1269               cnt (1+ cnt)))
1270       (when (and (integerp org-clock-into-drawer)
1271                  last
1272                  (>= (1+ cnt) org-clock-into-drawer))
1273         ;; Wrap current entries into a new drawer
1274         (goto-char last)
1275         (setq ind-last (org-get-indentation))
1276         (beginning-of-line 2)
1277         (if (and (>= (org-get-indentation) ind-last)
1278                  (org-at-item-p))
1279             (when (and (>= (org-get-indentation) ind-last)
1280                    (org-at-item-p))
1281               (let ((struct (org-list-struct)))
1282                 (goto-char (org-list-get-bottom-point struct)))))
1283         (insert ":END:\n")
1284         (beginning-of-line 0)
1285         (org-indent-line-to ind-last)
1286         (goto-char first)
1287         (insert ":" drawer ":\n")
1288         (beginning-of-line 0)
1289         (org-indent-line-function)
1290         (org-flag-drawer t)
1291         (beginning-of-line 2)
1292         (or org-log-states-order-reversed
1293             (and (re-search-forward org-property-end-re nil t)
1294                  (goto-char (match-beginning 0))))
1295         (throw 'exit nil))
1296
1297       (goto-char beg)
1298       (while (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
1299                   (not (equal (match-string 1) org-clock-string)))
1300         ;; Planning info, skip to after it
1301         (beginning-of-line 2)
1302         (or (bolp) (newline)))
1303       (when (or (eq org-clock-into-drawer t)
1304                 (stringp org-clock-into-drawer)
1305                 (and (integerp org-clock-into-drawer)
1306                      (< org-clock-into-drawer 2)))
1307         (insert ":" drawer ":\n:END:\n")
1308         (beginning-of-line -1)
1309         (org-indent-line-function)
1310         (org-flag-drawer t)
1311         (beginning-of-line 2)
1312         (org-indent-line-function)
1313         (beginning-of-line)
1314         (or org-log-states-order-reversed
1315             (and (re-search-forward org-property-end-re nil t)
1316                  (goto-char (match-beginning 0))))))))
1317
1318 (defun org-clock-out (&optional fail-quietly at-time)
1319   "Stop the currently running clock.
1320 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
1321   (interactive)
1322   (catch 'exit
1323     (when (not (org-clocking-p))
1324       (setq global-mode-string
1325             (delq 'org-mode-line-string global-mode-string))
1326       (force-mode-line-update)
1327       (if fail-quietly (throw 'exit t) (error "No active clock")))
1328     (let (ts te s h m remove)
1329       (save-excursion ; Do not replace this with `with-current-buffer'.
1330         (with-no-warnings (set-buffer (org-clocking-buffer)))
1331         (save-restriction
1332           (widen)
1333           (goto-char org-clock-marker)
1334           (beginning-of-line 1)
1335           (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
1336                    (equal (match-string 1) org-clock-string))
1337               (setq ts (match-string 2))
1338             (if fail-quietly (throw 'exit nil) (error "Clock start time is gone")))
1339           (goto-char (match-end 0))
1340           (delete-region (point) (point-at-eol))
1341           (insert "--")
1342           (setq te (org-insert-time-stamp (or at-time (current-time))
1343                                           'with-hm 'inactive))
1344           (setq s (- (org-float-time (apply 'encode-time (org-parse-time-string te)))
1345                      (org-float-time (apply 'encode-time (org-parse-time-string ts))))
1346                 h (floor (/ s 3600))
1347                 s (- s (* 3600 h))
1348                 m (floor (/ s 60))
1349                 s (- s (* 60 s)))
1350           (insert " => " (format "%2d:%02d" h m))
1351           (when (setq remove (and org-clock-out-remove-zero-time-clocks
1352                                   (= (+ h m) 0)))
1353             (beginning-of-line 1)
1354             (delete-region (point) (point-at-eol))
1355             (and (looking-at "\n") (> (point-max) (1+ (point)))
1356                  (delete-char 1)))
1357           (move-marker org-clock-marker nil)
1358           (move-marker org-clock-hd-marker nil)
1359           (when org-log-note-clock-out
1360             (org-add-log-setup 'clock-out nil nil nil nil
1361                                (concat "# Task: " (org-get-heading t) "\n\n")))
1362           (when org-clock-mode-line-timer
1363             (cancel-timer org-clock-mode-line-timer)
1364             (setq org-clock-mode-line-timer nil))
1365           (when org-clock-idle-timer
1366             (cancel-timer org-clock-idle-timer)
1367             (setq org-clock-idle-timer nil))
1368           (setq global-mode-string
1369                 (delq 'org-mode-line-string global-mode-string))
1370           (when org-clock-out-switch-to-state
1371             (save-excursion
1372               (org-back-to-heading t)
1373               (let ((org-inhibit-logging t)
1374                     (org-clock-out-when-done nil))
1375                 (cond
1376                  ((functionp org-clock-out-switch-to-state)
1377                   (looking-at org-complex-heading-regexp)
1378                   (let ((newstate (funcall org-clock-out-switch-to-state
1379                                            (match-string 2))))
1380                     (if newstate (org-todo newstate))))
1381                  ((and org-clock-out-switch-to-state
1382                        (not (looking-at (concat outline-regexp "[ \t]*"
1383                                                 org-clock-out-switch-to-state
1384                                                 "\\>"))))
1385                   (org-todo org-clock-out-switch-to-state))))))
1386           (force-mode-line-update)
1387           (message (concat "Clock stopped at %s after HH:MM = " org-time-clocksum-format "%s") te h m
1388                    (if remove " => LINE REMOVED" ""))
1389           (run-hooks 'org-clock-out-hook)
1390           (org-clock-delete-current))))))
1391
1392 (add-hook 'org-clock-out-hook 'org-clock-remove-empty-clock-drawer)
1393
1394 (defun org-clock-remove-empty-clock-drawer nil
1395   "Remove empty clock drawer in the current subtree."
1396   (let* ((olid (or (org-entry-get (point) "LOG_INTO_DRAWER")
1397                    org-log-into-drawer))
1398          (clock-drawer (if (eq t olid) "LOGBOOK" olid))
1399          (end (save-excursion (org-end-of-subtree t t))))
1400     (when clock-drawer
1401       (save-excursion
1402         (org-back-to-heading t)
1403         (while (search-forward clock-drawer end t)
1404           (goto-char (match-beginning 0))
1405           (org-remove-empty-drawer-at clock-drawer (point))
1406           (forward-line 1))))))
1407
1408 (defun org-at-clock-log-p nil
1409   "Is the cursor on the clock log line?"
1410   (save-excursion
1411     (move-beginning-of-line 1)
1412     (looking-at "^[ \t]*CLOCK:")))
1413
1414 (defun org-clock-timestamps-up nil
1415   "Increase CLOCK timestamps at cursor."
1416   (interactive)
1417   (org-clock-timestamps-change 'up))
1418
1419 (defun org-clock-timestamps-down nil
1420   "Increase CLOCK timestamps at cursor."
1421   (interactive)
1422   (org-clock-timestamps-change 'down))
1423
1424 (defun org-clock-timestamps-change (updown)
1425   "Change CLOCK timestamps synchronuously at cursor.
1426 UPDOWN tells whether to change 'up or 'down."
1427   (setq org-ts-what nil)
1428   (when (org-at-timestamp-p t)
1429     (let ((tschange (if (eq updown 'up) 'org-timestamp-up 
1430                       'org-timestamp-down))
1431           ts1 begts1 ts2 begts2 updatets1 tdiff)
1432       (save-excursion
1433         (move-beginning-of-line 1)
1434         (re-search-forward org-ts-regexp3 nil t)
1435         (setq ts1 (match-string 0) begts1 (match-beginning 0))
1436         (when (re-search-forward org-ts-regexp3 nil t)
1437           (setq ts2 (match-string 0) begts2 (match-beginning 0))))
1438       ; Are we on the second timestamp?
1439       (if (<= begts2 (point)) (setq updatets1 t))
1440       (if (not ts2)
1441           ;; fall back on org-timestamp-up if there is only one
1442           (funcall tschange)
1443         ;; setq this so that (boundp 'org-ts-what is non-nil)
1444         (funcall tschange)
1445         (let ((ts (if updatets1 ts2 ts1))
1446               (begts (if updatets1 begts1 begts2)))
1447           (setq tdiff               
1448                 (subtract-time
1449                  (org-time-string-to-time org-last-changed-timestamp)
1450                  (org-time-string-to-time ts)))
1451           (save-excursion
1452             (goto-char begts)
1453             (org-timestamp-change
1454              (round (/ (org-float-time tdiff) 
1455                        (cond ((eq org-ts-what 'minute) 60)
1456                              ((eq org-ts-what 'hour) 3600)
1457                              ((eq org-ts-what 'day) (* 24 3600))
1458                              ((eq org-ts-what 'month) (* 24 3600 31))
1459                              ((eq org-ts-what 'year) (* 24 3600 365.2)))))
1460              org-ts-what 'updown)))))))
1461
1462 (defun org-clock-cancel ()
1463   "Cancel the running clock by removing the start timestamp."
1464   (interactive)
1465   (when (not (org-clocking-p))
1466     (setq global-mode-string
1467          (delq 'org-mode-line-string global-mode-string))
1468     (force-mode-line-update)
1469     (error "No active clock"))
1470   (save-excursion ; Do not replace this with `with-current-buffer'.
1471     (with-no-warnings (set-buffer (org-clocking-buffer)))
1472     (goto-char org-clock-marker)
1473     (delete-region (1- (point-at-bol)) (point-at-eol))
1474     ;; Just in case, remove any empty LOGBOOK left over
1475     (org-remove-empty-drawer-at "LOGBOOK" (point)))
1476   (move-marker org-clock-marker nil)
1477   (move-marker org-clock-hd-marker nil)
1478   (setq global-mode-string
1479         (delq 'org-mode-line-string global-mode-string))
1480   (force-mode-line-update)
1481   (message "Clock canceled")
1482   (run-hooks 'org-clock-cancel-hook))
1483
1484 (defun org-clock-goto (&optional select)
1485   "Go to the currently clocked-in entry, or to the most recently clocked one.
1486 With prefix arg SELECT, offer recently clocked tasks for selection."
1487   (interactive "@P")
1488   (let* ((recent nil)
1489          (m (cond
1490              (select
1491               (or (org-clock-select-task "Select task to go to: ")
1492                   (error "No task selected")))
1493              ((org-clocking-p) org-clock-marker)
1494              ((and org-clock-goto-may-find-recent-task
1495                    (car org-clock-history)
1496                    (marker-buffer (car org-clock-history)))
1497               (setq recent t)
1498               (car org-clock-history))
1499              (t (error "No active or recent clock task")))))
1500     (switch-to-buffer (marker-buffer m))
1501     (if (or (< m (point-min)) (> m (point-max))) (widen))
1502     (goto-char m)
1503     (org-show-entry)
1504     (org-back-to-heading t)
1505     (org-cycle-hide-drawers 'children)
1506     (recenter)
1507     (org-reveal)
1508     (if recent
1509         (message "No running clock, this is the most recently clocked task"))
1510     (run-hooks 'org-clock-goto-hook)))
1511
1512 (defvar org-clock-file-total-minutes nil
1513   "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1514 (make-variable-buffer-local 'org-clock-file-total-minutes)
1515
1516 (defun org-clock-sum (&optional tstart tend headline-filter)
1517   "Sum the times for each subtree.
1518 Puts the resulting times in minutes as a text property on each headline.
1519 TSTART and TEND can mark a time range to be considered.  HEADLINE-FILTER is a
1520 zero-arg function that, if specified, is called for each headline in the time
1521 range with point at the headline.  Headlines for which HEADLINE-FILTER returns
1522 nil are excluded from the clock summation."
1523   (interactive)
1524   (let* ((bmp (buffer-modified-p))
1525          (re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1526                      org-clock-string
1527                      "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1528          (lmax 30)
1529          (ltimes (make-vector lmax 0))
1530          (t1 0)
1531          (level 0)
1532          ts te dt
1533          time)
1534     (if (stringp tstart) (setq tstart (org-time-string-to-seconds tstart)))
1535     (if (stringp tend) (setq tend (org-time-string-to-seconds tend)))
1536     (if (consp tstart) (setq tstart (org-float-time tstart)))
1537     (if (consp tend) (setq tend (org-float-time tend)))
1538     (remove-text-properties (point-min) (point-max)
1539                             '(:org-clock-minutes t
1540                               :org-clock-force-headline-inclusion t))
1541     (save-excursion
1542       (goto-char (point-max))
1543       (while (re-search-backward re nil t)
1544         (cond
1545          ((match-end 2)
1546           ;; Two time stamps
1547           (setq ts (match-string 2)
1548                 te (match-string 3)
1549                 ts (org-float-time
1550                     (apply 'encode-time (org-parse-time-string ts)))
1551                 te (org-float-time
1552                     (apply 'encode-time (org-parse-time-string te)))
1553                 ts (if tstart (max ts tstart) ts)
1554                 te (if tend (min te tend) te)
1555                 dt (- te ts)
1556                 t1 (if (> dt 0) (+ t1 (floor (/ dt 60))) t1)))
1557          ((match-end 4)
1558           ;; A naked time
1559           (setq t1 (+ t1 (string-to-number (match-string 5))
1560                       (* 60 (string-to-number (match-string 4))))))
1561          (t ;; A headline
1562           ;; Add the currently clocking item time to the total
1563           (when (and org-clock-report-include-clocking-task
1564                      (equal (org-clocking-buffer) (current-buffer))
1565                      (equal (marker-position org-clock-hd-marker) (point))
1566                      tstart
1567                      tend
1568                      (>= (org-float-time org-clock-start-time) tstart)
1569                      (<= (org-float-time org-clock-start-time) tend))
1570             (let ((time (floor (- (org-float-time)
1571                                   (org-float-time org-clock-start-time)) 60)))
1572               (setq t1 (+ t1 time))))
1573           (let* ((headline-forced
1574                   (get-text-property (point)
1575                                      :org-clock-force-headline-inclusion))
1576                  (headline-included
1577                   (or (null headline-filter)
1578                       (save-excursion
1579                         (save-match-data (funcall headline-filter))))))
1580             (setq level (- (match-end 1) (match-beginning 1)))
1581             (when (or (> t1 0) (> (aref ltimes level) 0))
1582               (when (or headline-included headline-forced)
1583                 (if headline-included
1584                     (loop for l from 0 to level do
1585                           (aset ltimes l (+ (aref ltimes l) t1))))
1586                 (setq time (aref ltimes level))
1587                 (goto-char (match-beginning 0))
1588                 (put-text-property (point) (point-at-eol) :org-clock-minutes time)
1589                 (if headline-filter
1590                     (save-excursion
1591                       (save-match-data
1592                         (while
1593                             (> (funcall outline-level) 1)
1594                           (outline-up-heading 1 t)
1595                           (put-text-property
1596                            (point) (point-at-eol)
1597                            :org-clock-force-headline-inclusion t))))))
1598               (setq t1 0)
1599               (loop for l from level to (1- lmax) do
1600                     (aset ltimes l 0)))))))
1601       (setq org-clock-file-total-minutes (aref ltimes 0)))
1602     (set-buffer-modified-p bmp)))
1603
1604 (defun org-clock-sum-current-item (&optional tstart)
1605   "Return time, clocked on current item in total."
1606   (save-excursion
1607     (save-restriction
1608       (org-narrow-to-subtree)
1609       (org-clock-sum tstart)
1610       org-clock-file-total-minutes)))
1611
1612 (defun org-clock-display (&optional total-only)
1613   "Show subtree times in the entire buffer.
1614 If TOTAL-ONLY is non-nil, only show the total time for the entire file
1615 in the echo area.
1616
1617 Use \\[org-clock-remove-overlays] to remove the subtree times."
1618   (interactive)
1619   (org-clock-remove-overlays)
1620   (let (time h m p)
1621     (org-clock-sum)
1622     (unless total-only
1623       (save-excursion
1624         (goto-char (point-min))
1625         (while (or (and (equal (setq p (point)) (point-min))
1626                         (get-text-property p :org-clock-minutes))
1627                    (setq p (next-single-property-change
1628                             (point) :org-clock-minutes)))
1629           (goto-char p)
1630           (when (setq time (get-text-property p :org-clock-minutes))
1631             (org-clock-put-overlay time (funcall outline-level))))
1632         (setq h (/ org-clock-file-total-minutes 60)
1633               m (- org-clock-file-total-minutes (* 60 h)))
1634         ;; Arrange to remove the overlays upon next change.
1635         (when org-remove-highlights-with-change
1636           (org-add-hook 'before-change-functions 'org-clock-remove-overlays
1637                         nil 'local))))
1638     (if org-time-clocksum-use-fractional
1639         (message (concat "Total file time: " org-time-clocksum-fractional-format
1640                          " (%d hours and %d minutes)")
1641                  (/ (+ (* h 60.0) m) 60.0) h m)
1642       (message (concat "Total file time: " org-time-clocksum-format
1643                        " (%d hours and %d minutes)") h m h m))))
1644
1645 (defvar org-clock-overlays nil)
1646 (make-variable-buffer-local 'org-clock-overlays)
1647
1648 (defun org-clock-put-overlay (time &optional level)
1649   "Put an overlays on the current line, displaying TIME.
1650 If LEVEL is given, prefix time with a corresponding number of stars.
1651 This creates a new overlay and stores it in `org-clock-overlays', so that it
1652 will be easy to remove."
1653   (let* ((c 60) (h (floor (/ time 60))) (m (- time (* 60 h)))
1654          (l (if level (org-get-valid-level level 0) 0))
1655          (fmt (concat "%s " (if org-time-clocksum-use-fractional
1656                                 org-time-clocksum-fractional-format
1657                               org-time-clocksum-format) "%s"))
1658          (off 0)
1659          ov tx)
1660     (org-move-to-column c)
1661     (unless (eolp) (skip-chars-backward "^ \t"))
1662     (skip-chars-backward " \t")
1663     (setq ov (make-overlay (1- (point)) (point-at-eol))
1664           tx (concat (buffer-substring (1- (point)) (point))
1665                      (make-string (+ off (max 0 (- c (current-column)))) ?.)
1666                      (org-add-props (if org-time-clocksum-use-fractional
1667                                         (format fmt
1668                                                 (make-string l ?*)
1669                                                 (/ (+ (* h 60.0) m) 60.0)
1670                                                 (make-string (- 16 l) ?\ ))
1671                                       (format fmt
1672                                               (make-string l ?*) h m
1673                                               (make-string (- 16 l) ?\ )))
1674                          (list 'face 'org-clock-overlay))
1675                      ""))
1676     (if (not (featurep 'xemacs))
1677         (overlay-put ov 'display tx)
1678       (overlay-put ov 'invisible t)
1679       (overlay-put ov 'end-glyph (make-glyph tx)))
1680     (push ov org-clock-overlays)))
1681
1682 (defun org-clock-remove-overlays (&optional beg end noremove)
1683   "Remove the occur highlights from the buffer.
1684 BEG and END are ignored.  If NOREMOVE is nil, remove this function
1685 from the `before-change-functions' in the current buffer."
1686   (interactive)
1687   (unless org-inhibit-highlight-removal
1688     (mapc 'delete-overlay org-clock-overlays)
1689     (setq org-clock-overlays nil)
1690     (unless noremove
1691       (remove-hook 'before-change-functions
1692                    'org-clock-remove-overlays 'local))))
1693
1694 (defvar state) ;; dynamically scoped into this function
1695 (defun org-clock-out-if-current ()
1696   "Clock out if the current entry contains the running clock.
1697 This is used to stop the clock after a TODO entry is marked DONE,
1698 and is only done if the variable `org-clock-out-when-done' is not nil."
1699   (when (and org-clock-out-when-done
1700              (or (and (eq t org-clock-out-when-done)
1701                       (member state org-done-keywords))
1702                  (and (listp org-clock-out-when-done)
1703                       (member state org-clock-out-when-done)))
1704              (equal (or (buffer-base-buffer (org-clocking-buffer))
1705                         (org-clocking-buffer))
1706                     (or (buffer-base-buffer (current-buffer))
1707                         (current-buffer)))
1708              (< (point) org-clock-marker)
1709              (> (save-excursion (outline-next-heading) (point))
1710                 org-clock-marker))
1711     ;; Clock out, but don't accept a logging message for this.
1712     (let ((org-log-note-clock-out nil)
1713           (org-clock-out-switch-to-state nil))
1714       (org-clock-out))))
1715
1716 (add-hook 'org-after-todo-state-change-hook
1717           'org-clock-out-if-current)
1718
1719 ;;;###autoload
1720 (defun org-get-clocktable (&rest props)
1721   "Get a formatted clocktable with parameters according to PROPS.
1722 The table is created in a temporary buffer, fully formatted and
1723 fontified, and then returned."
1724   ;; Set the defaults
1725   (setq props (plist-put props :name "clocktable"))
1726   (unless (plist-member props :maxlevel)
1727     (setq props (plist-put props :maxlevel 2)))
1728   (unless (plist-member props :scope)
1729     (setq props (plist-put props :scope 'agenda)))
1730   (with-temp-buffer
1731     (org-mode)
1732     (org-create-dblock props)
1733     (org-update-dblock)
1734     (font-lock-fontify-buffer)
1735     (forward-line 2)
1736     (buffer-substring (point) (progn
1737                                 (re-search-forward "^[ \t]*#\\+END" nil t)
1738                                 (point-at-bol)))))
1739
1740 (defun org-clock-report (&optional arg)
1741   "Create a table containing a report about clocked time.
1742 If the cursor is inside an existing clocktable block, then the table
1743 will be updated.  If not, a new clocktable will be inserted.  The scope
1744 of the new clock will be subtree when called from within a subtree, and 
1745 file elsewhere.
1746
1747 When called with a prefix argument, move to the first clock table in the
1748 buffer and update it."
1749   (interactive "P")
1750   (org-clock-remove-overlays)
1751   (when arg
1752     (org-find-dblock "clocktable")
1753     (org-show-entry))
1754   (if (org-in-clocktable-p)
1755       (goto-char (org-in-clocktable-p))
1756     (let ((props (if (ignore-errors 
1757                        (save-excursion (org-back-to-heading)))
1758                      (list :name "clocktable" :scope 'subtree)
1759                    (list :name "clocktable"))))
1760       (org-create-dblock 
1761        (org-combine-plists org-clock-clocktable-default-properties props))))
1762   (org-update-dblock))
1763
1764 (defun org-in-clocktable-p ()
1765   "Check if the cursor is in a clocktable."
1766   (let ((pos (point)) start)
1767     (save-excursion
1768       (end-of-line 1)
1769       (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
1770            (setq start (match-beginning 0))
1771            (re-search-forward "^[ \t]*#\\+END:.*" nil t)
1772            (>= (match-end 0) pos)
1773            start))))
1774
1775 (defun org-day-of-week (day month year)
1776   "Returns the day of the week as an integer."
1777   (nth 6
1778        (decode-time
1779         (date-to-time
1780          (format "%d-%02d-%02dT00:00:00" year month day)))))
1781
1782 (defun org-quarter-to-date (quarter year)
1783   "Get the date (week day year) of the first day of a given quarter."
1784   (let (startday)
1785     (cond
1786      ((= quarter 1)
1787       (setq startday (org-day-of-week 1 1 year))
1788       (cond
1789        ((= startday 0)
1790         (list 52 7 (- year 1)))
1791        ((= startday 6)
1792         (list 52 6 (- year 1)))
1793        ((<= startday 4)
1794         (list 1 startday year))
1795        ((> startday 4)
1796         (list 53 startday (- year 1)))
1797        )
1798       )
1799      ((= quarter 2)
1800       (setq startday (org-day-of-week 1 4 year))
1801       (cond
1802        ((= startday 0)
1803         (list 13 startday year))
1804        ((< startday 4)
1805         (list 14 startday year))
1806        ((>= startday 4)
1807         (list 13 startday year))
1808        )
1809       )
1810      ((= quarter 3)
1811       (setq startday (org-day-of-week 1 7 year))
1812       (cond
1813        ((= startday 0)
1814         (list 26 startday year))
1815        ((< startday 4)
1816         (list 27 startday year))
1817        ((>= startday 4)
1818         (list 26 startday year))
1819        )
1820       )
1821      ((= quarter 4)
1822       (setq startday (org-day-of-week 1 10 year))
1823       (cond
1824        ((= startday 0)
1825         (list 39 startday year))
1826        ((<= startday 4)
1827         (list 40 startday year))
1828        ((> startday 4)
1829         (list 39 startday year)))))))
1830
1831 (defun org-clock-special-range (key &optional time as-strings)
1832   "Return two times bordering a special time range.
1833 Key is a symbol specifying the range and can be one of `today', `yesterday',
1834 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
1835 A week starts Monday 0:00 and ends Sunday 24:00.
1836 The range is determined relative to TIME.  TIME defaults to the current time.
1837 The return value is a cons cell with two internal times like the ones
1838 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
1839 the returned times will be formatted strings."
1840   (if (integerp key) (setq key (intern (number-to-string key))))
1841   (let* ((tm (decode-time (or time (current-time))))
1842          (s 0) (m (nth 1 tm)) (h (nth 2 tm))
1843          (d (nth 3 tm)) (month (nth 4 tm)) (y (nth 5 tm))
1844          (dow (nth 6 tm))
1845          (skey (symbol-name key))
1846          (shift 0)
1847          (q (cond ((>= (nth 4 tm) 10) 4)
1848                   ((>= (nth 4 tm) 7) 3)
1849                   ((>= (nth 4 tm) 4) 2)
1850                   ((>= (nth 4 tm) 1) 1)))
1851          s1 m1 h1 d1 month1 y1 diff ts te fm txt w date
1852          interval tmp shiftedy shiftedm shiftedq)
1853     (cond
1854      ((string-match "^[0-9]+$" skey)
1855       (setq y (string-to-number skey) m 1 d 1 key 'year))
1856      ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)$" skey)
1857       (setq y (string-to-number (match-string 1 skey))
1858             month (string-to-number (match-string 2 skey))
1859             d 1 key 'month))
1860      ((string-match "^\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)$" skey)
1861       (require 'cal-iso)
1862       (setq y (string-to-number (match-string 1 skey))
1863             w (string-to-number (match-string 2 skey)))
1864       (setq date (calendar-gregorian-from-absolute
1865                   (calendar-absolute-from-iso (list w 1 y))))
1866       (setq d (nth 1 date) month (car date) y (nth 2 date)
1867             dow 1
1868             key 'week))
1869       ((string-match "^\\([0-9]+\\)-[qQ]\\([1-4]\\)$" skey)
1870        (require 'cal-iso)
1871        (setq y (string-to-number (match-string 1 skey)))
1872        (setq q (string-to-number (match-string 2 skey)))
1873        (setq date (calendar-gregorian-from-absolute
1874                    (calendar-absolute-from-iso (org-quarter-to-date q y))))
1875        (setq d (nth 1 date) month (car date) y (nth 2 date)
1876             dow 1
1877             key 'quarter))
1878      ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)$" skey)
1879       (setq y (string-to-number (match-string 1 skey))
1880             month (string-to-number (match-string 2 skey))
1881             d (string-to-number (match-string 3 skey))
1882             key 'day))
1883      ((string-match "\\([-+][0-9]+\\)$" skey)
1884       (setq shift (string-to-number (match-string 1 skey))
1885             key (intern (substring skey 0 (match-beginning 1))))
1886        (if(and (memq key '(quarter thisq)) (> shift 0))
1887          (error "Looking forward with quarters isn't implemented.")
1888         ())))
1889
1890     (when (= shift 0)
1891        (cond ((eq key 'yesterday) (setq key 'today   shift -1))
1892             ((eq key 'lastweek)  (setq key 'week    shift -1))
1893             ((eq key 'lastmonth) (setq key 'month   shift -1))
1894             ((eq key 'lastyear)  (setq key 'year    shift -1))
1895             ((eq key 'lastq)     (setq key 'quarter shift -1))))
1896     (cond
1897      ((memq key '(day today))
1898       (setq d (+ d shift) h 0 m 0 h1 24 m1 0))
1899      ((memq key '(week thisweek))
1900       (setq diff (+ (* -7 shift) (if (= dow 0) 6 (1- dow)))
1901             m 0 h 0 d (- d diff) d1 (+ 7 d)))
1902      ((memq key '(month thismonth))
1903       (setq d 1 h 0 m 0 d1 1 month (+ month shift) month1 (1+ month) h1 0 m1 0))
1904      ((memq key '(quarter thisq))
1905       ; compute if this shift remains in this year
1906       ; if not, compute how many years and quarters we have to shift (via floor*)
1907       ; and compute the shifted years, months and quarters
1908       (cond
1909        ((< (+ (- q 1) shift) 0) ; shift not in this year
1910        (setq interval (* -1 (+ (- q 1) shift)))
1911        ; set tmp to ((years to shift) (quarters to shift))
1912        (setq tmp (org-floor* interval 4))
1913        ; due to the use of floor, 0 quarters actually means 4
1914        (if (= 0 (nth 1 tmp))
1915            (setq shiftedy (- y (nth 0 tmp))
1916                  shiftedm 1
1917                  shiftedq 1)
1918          (setq shiftedy (- y (+ 1 (nth 0 tmp)))
1919                shiftedm (- 13 (* 3 (nth 1 tmp)))
1920                shiftedq (- 5 (nth 1 tmp))))
1921        (setq d 1 h 0 m 0 d1 1 month shiftedm month1 (+ 3 shiftedm) h1 0 m1 0 y shiftedy))
1922        ((> (+ q shift) 0) ; shift is whitin this year
1923        (setq shiftedq (+ q shift))
1924        (setq shiftedy y)
1925        (setq d 1 h 0 m 0 d1 1 month (+ 1 (* 3 (- (+ q shift) 1))) month1 (+ 4 (* 3 (- (+ q shift) 1))) h1 0 m1 0))))
1926      ((memq key '(year thisyear))
1927       (setq m 0 h 0 d 1 month 1 y (+ y shift) y1 (1+ y)))
1928      (t (error "No such time block %s" key)))
1929     (setq ts (encode-time s m h d month y)
1930           te (encode-time (or s1 s) (or m1 m) (or h1 h)
1931                           (or d1 d) (or month1 month) (or y1 y)))
1932     (setq fm (cdr org-time-stamp-formats))
1933     (cond
1934      ((memq key '(day today))
1935       (setq txt (format-time-string "%A, %B %d, %Y" ts)))
1936      ((memq key '(week thisweek))
1937       (setq txt (format-time-string "week %G-W%V" ts)))
1938      ((memq key '(month thismonth))
1939       (setq txt (format-time-string "%B %Y" ts)))
1940      ((memq key '(year thisyear))
1941       (setq txt (format-time-string "the year %Y" ts)))
1942      ((memq key '(quarter thisq))
1943       (setq txt (concatenate 'string (org-count-quarter shiftedq) " quarter of " (number-to-string shiftedy))))
1944      )
1945     (if as-strings
1946         (list (format-time-string fm ts) (format-time-string fm te) txt)
1947       (list ts te txt))))
1948
1949 (defun org-count-quarter (n)
1950   (cond
1951    ((= n 1) "1st")
1952    ((= n 2) "2nd")
1953    ((= n 3) "3rd")
1954    ((= n 4) "4th")))
1955
1956 (defun org-clocktable-shift (dir n)
1957   "Try to shift the :block date of the clocktable at point.
1958 Point must be in the #+BEGIN: line of a clocktable, or this function
1959 will throw an error.
1960 DIR is a direction, a symbol `left', `right', `up', or `down'.
1961 Both `left' and `down' shift the block toward the past, `up' and `right'
1962 push it toward the future.
1963 N is the number of shift steps to take.  The size of the step depends on
1964 the currently selected interval size."
1965   (setq n (prefix-numeric-value n))
1966   (and (memq dir '(left down)) (setq n (- n)))
1967   (save-excursion
1968     (goto-char (point-at-bol))
1969     (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
1970         (error "Line needs a :block definition before this command works")
1971       (let* ((b (match-beginning 1)) (e (match-end 1))
1972              (s (match-string 1))
1973              block shift ins y mw d date wp m)
1974         (cond
1975          ((equal s "yesterday") (setq s "today-1"))
1976          ((equal s "lastweek") (setq s "thisweek-1"))
1977          ((equal s "lastmonth") (setq s "thismonth-1"))
1978          ((equal s "lastyear") (setq s "thisyear-1"))
1979          ((equal s "lastq") (setq s "thisq-1")))
1980
1981        (cond
1982         ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s)
1983          (setq block (match-string 1 s)
1984                shift (if (match-end 2)
1985                          (string-to-number (match-string 2 s))
1986                        0))
1987          (setq shift (+ shift n))
1988          (setq ins (if (= shift 0) block (format "%s%+d" block shift))))
1989         ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s)
1990         ;;               1        1  2   3       3  4                  4  5   6                6  5   2
1991          (setq y (string-to-number (match-string 1 s))
1992                wp (and (match-end 3) (match-string 3 s))
1993                mw (and (match-end 4) (string-to-number (match-string 4 s)))
1994                d (and (match-end 6) (string-to-number (match-string 6 s))))
1995          (cond
1996           (d (setq ins (format-time-string
1997                         "%Y-%m-%d"
1998                         (encode-time 0 0 0 (+ d n) m y))))
1999           ((and wp (string-match "w\\|W" wp) mw (> (length wp) 0))
2000            (require 'cal-iso)
2001            (setq date (calendar-gregorian-from-absolute (calendar-absolute-from-iso (list (+ mw n) 1 y))))
2002            (setq ins (format-time-string
2003                       "%G-W%V"
2004                       (encode-time 0 0 0 (nth 1 date) (car date) (nth 2 date)))))
2005           ((and wp (string-match "q\\|Q" wp) mw (> (length wp) 0))
2006            (require 'cal-iso)
2007            ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2008            (if (> (+ mw n) 4)
2009                (setq mw 0
2010                      y (+ 1 y))
2011              ())
2012            ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2013            (if (= (+ mw n) 0)
2014                (setq mw 5
2015                      y (- y 1))
2016              ())
2017            (setq date (calendar-gregorian-from-absolute (calendar-absolute-from-iso (org-quarter-to-date (+ mw n) y))))
2018            (setq ins (format-time-string
2019                       (concatenate 'string (number-to-string y) "-Q" (number-to-string (+ mw n)))
2020                       (encode-time 0 0 0 (nth 1 date) (car date) (nth 2 date)))))
2021           (mw
2022            (setq ins (format-time-string
2023                       "%Y-%m"
2024                       (encode-time 0 0 0 1 (+ mw n) y))))
2025           (y
2026            (setq ins (number-to-string (+ y n))))))
2027         (t (error "Cannot shift clocktable block")))
2028        (when ins
2029          (goto-char b)
2030          (insert ins)
2031          (delete-region (point) (+ (point) (- e b)))
2032          (beginning-of-line 1)
2033          (org-update-dblock)
2034          t)))))
2035
2036 (defun org-dblock-write:clocktable (params)
2037   "Write the standard clocktable."
2038   (setq params (org-combine-plists org-clocktable-defaults params))
2039   (catch 'exit
2040     (let* ((scope (plist-get params :scope))
2041            (block (plist-get params :block))
2042            (ts (plist-get params :tstart))
2043            (te (plist-get params :tend))
2044            (link (plist-get params :link))
2045            (maxlevel (or (plist-get params :maxlevel) 3))
2046            (step (plist-get params :step))
2047            (timestamp (plist-get params :timestamp))
2048            (formatter (or (plist-get params :formatter)
2049                           org-clock-clocktable-formatter
2050                           'org-clocktable-write-default))
2051            cc range-text ipos pos one-file-with-archives
2052            scope-is-list tbls level)
2053
2054       ;; Check if we need to do steps
2055       (when block
2056         ;; Get the range text for the header
2057         (setq cc (org-clock-special-range block nil t)
2058               ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
2059       (when step
2060         ;; Write many tables, in steps
2061         (unless (or block (and ts te))
2062           (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2063         (org-clocktable-steps params)
2064         (throw 'exit nil))
2065
2066       (setq ipos (point)) ; remember the insertion position
2067
2068       ;; Get the right scope
2069       (setq pos (point))
2070       (cond
2071        ((and scope (listp scope) (symbolp (car scope)))
2072         (setq scope (eval scope)))
2073        ((eq scope 'agenda)
2074         (setq scope (org-agenda-files t)))
2075        ((eq scope 'agenda-with-archives)
2076         (setq scope (org-agenda-files t))
2077         (setq scope (org-add-archive-files scope)))
2078        ((eq scope 'file-with-archives)
2079         (setq scope (org-add-archive-files (list (buffer-file-name)))
2080               one-file-with-archives t)))
2081       (setq scope-is-list (and scope (listp scope)))
2082       (if scope-is-list
2083           ;; we collect from several files
2084           (let* ((files scope)
2085                  file)
2086             (org-prepare-agenda-buffers files)
2087             (while (setq file (pop files))
2088               (with-current-buffer (find-buffer-visiting file)
2089                 (save-excursion
2090                   (save-restriction
2091                     (push (org-clock-get-table-data file params) tbls))))))
2092         ;; Just from the current file
2093         (save-restriction
2094           ;; get the right range into the restriction
2095           (org-prepare-agenda-buffers (list (buffer-file-name)))
2096           (cond
2097            ((not scope))  ; use the restriction as it is now
2098            ((eq scope 'file) (widen))
2099            ((eq scope 'subtree) (org-narrow-to-subtree))
2100            ((eq scope 'tree)
2101             (while (org-up-heading-safe))
2102             (org-narrow-to-subtree))
2103            ((and (symbolp scope) (string-match "^tree\\([0-9]+\\)$"
2104                                                (symbol-name scope)))
2105             (setq level (string-to-number (match-string 1 (symbol-name scope))))
2106             (catch 'exit
2107               (while (org-up-heading-safe)
2108                 (looking-at outline-regexp)
2109                 (if (<= (org-reduced-level (funcall outline-level)) level)
2110                     (throw 'exit nil))))
2111             (org-narrow-to-subtree)))
2112           ;; do the table, with no file name.
2113           (push (org-clock-get-table-data nil params) tbls)))
2114
2115       ;; OK, at this point we tbls as a list of tables, one per file
2116       (setq tbls (nreverse tbls))
2117
2118       (setq params (plist-put params :multifile scope-is-list))
2119       (setq params (plist-put params :one-file-with-archives
2120                               one-file-with-archives))
2121
2122       (funcall formatter ipos tbls params))))
2123
2124 (defun org-clocktable-write-default (ipos tables params)
2125   "Write out a clock table at position IPOS in the current buffer.
2126 TABLES is a list of tables with clocking data as produced by
2127 `org-clock-get-table-data'.  PARAMS is the parameter property list obtained
2128 from the dynamic block defintion."
2129   ;; This function looks quite complicated, mainly because there are a
2130   ;; lot of options which can add or remove columns.  I have massively
2131   ;; commented this function, the I hope it is understandable.  If
2132   ;; someone wants to write their own special formatter, this maybe
2133   ;; much easier because there can be a fixed format with a
2134   ;; well-defined number of columns...
2135   (let* ((hlchars '((1 . "*") (2 . "/")))
2136          (lwords (assoc (or (plist-get params :lang) 
2137                             org-export-default-language)
2138                         org-clock-clocktable-language-setup))
2139          (multifile (plist-get params :multifile))
2140          (block (plist-get params :block))
2141          (ts (plist-get params :tstart))
2142          (te (plist-get params :tend))
2143          (header (plist-get  params :header))
2144          (narrow (plist-get params :narrow))
2145          (link (plist-get params :link))
2146          (maxlevel (or (plist-get params :maxlevel) 3))
2147          (emph (plist-get params :emphasize))
2148          (level-p (plist-get params :level))
2149          (timestamp (plist-get params :timestamp))
2150          (properties (plist-get params :properties))
2151          (ntcol (max 1 (or (plist-get params :tcolumns) 100)))
2152          (rm-file-column (plist-get params :one-file-with-archives))
2153          (indent (plist-get params :indent))
2154          range-text total-time tbl level hlc formula pcol
2155          file-time entries entry headline
2156          recalc content narrow-cut-p tcol)
2157
2158     ;; Implement abbreviations
2159     (when (plist-get params :compact)
2160       (setq level nil indent t narrow (or narrow '40!) ntcol 1))
2161
2162     ;; Some consistency test for parameters
2163       (unless (integerp ntcol)
2164         (setq params (plist-put params :tcolumns (setq ntcol 100))))
2165
2166       (when (and narrow (integerp narrow) link)
2167         ;; We cannot have both integer narrow and link
2168         (message
2169          "Using hard narrowing in clocktable to allow for links")
2170         (setq narrow (intern (format "%d!" narrow))))
2171
2172       (when narrow
2173         (cond
2174          ((integerp narrow))
2175          ((and (symbolp narrow)
2176                (string-match "\\`[0-9]+!\\'" (symbol-name narrow)))
2177           (setq narrow-cut-p t
2178                 narrow (string-to-number (substring (symbol-name narrow)
2179                                                     0 -1))))
2180          (t
2181           (error "Invalid value %s of :narrow property in clock table"
2182                  narrow))))
2183
2184       (when block
2185         ;; Get the range text for the header
2186         (setq range-text (nth 2 (org-clock-special-range block nil t))))
2187
2188       ;; Compute the total time
2189       (setq total-time (apply '+ (mapcar 'cadr tables)))
2190
2191       ;; Now we need to output this tsuff
2192       (goto-char ipos)
2193
2194       ;; Insert the text *before* the actual table
2195       (insert-before-markers
2196        (or header
2197            ;; Format the standard header
2198            (concat
2199             (nth 9 lwords) " ["
2200             (substring
2201              (format-time-string (cdr org-time-stamp-formats))
2202              1 -1)
2203             "]"
2204             (if block (concat ", for " range-text ".") "")
2205             "\n\n")))
2206
2207       ;; Insert the narrowing line
2208       (when (and narrow (integerp narrow) (not narrow-cut-p))
2209         (insert-before-markers
2210          "|"                            ; table line starter
2211          (if multifile "|" "")          ; file column, maybe
2212          (if level-p   "|" "")          ; level column, maybe
2213          (if timestamp "|" "")          ; timestamp column, maybe
2214          (if properties (make-string (length properties) ?|) "")  ;properties columns, maybe
2215          (format "<%d>| |\n" narrow)))  ; headline and time columns
2216
2217       ;; Insert the table header line
2218       (insert-before-markers
2219        "|"                              ; table line starter
2220        (if multifile (concat (nth 1 lwords) "|") "")  ; file column, maybe
2221        (if level-p   (concat (nth 2 lwords) "|") "")  ; level column, maybe
2222        (if timestamp (concat (nth 3 lwords) "|") "")  ; timestamp column, maybe
2223        (if properties (concat (mapconcat 'identity properties "|") "|") "") ;properties columns, maybe
2224        (concat (nth 4 lwords) "|" 
2225                (nth 5 lwords) "|\n"))                 ; headline and time columns
2226
2227       ;; Insert the total time in the table
2228       (insert-before-markers
2229        "|-\n"                            ; a hline
2230        "|"                               ; table line starter
2231        (if multifile (concat "| " (nth 6 lwords) " ") "") 
2232                                          ; file column, maybe
2233        (if level-p   "|"      "")        ; level column, maybe
2234        (if timestamp "|"      "")        ; timestamp column, maybe
2235        (if properties (make-string (length properties) ?|) "")  ;properties columns, maybe
2236        (concat "*" (nth 7 lwords) "*| ") ; instead of a headline
2237        "*"
2238        (org-minutes-to-hh:mm-string (or total-time 0)) ; the time
2239        "*|\n")                          ; close line
2240
2241       ;; Now iterate over the tables and insert the data
2242       ;; but only if any time has been collected
2243       (when (and total-time (> total-time 0))
2244
2245         (while (setq tbl (pop tables))
2246           ;; now tbl is the table resulting from one file.
2247           (setq file-time (nth 1 tbl))
2248           (when (or (and file-time (> file-time 0))
2249                     (not (plist-get params :fileskip0)))
2250             (insert-before-markers "|-\n")  ; a hline because a new file starts
2251             ;; First the file time, if we have multiple files
2252             (when multifile
2253               ;; Summarize the time collected from this file
2254               (insert-before-markers
2255                (format (concat "| %s %s | %s%s*" (nth 8 lwords) "* | *%s*|\n")
2256                        (file-name-nondirectory (car tbl))
2257                        (if level-p   "| " "") ; level column, maybe
2258                        (if timestamp "| " "") ; timestamp column, maybe
2259                        (if properties (make-string (length properties) ?|) "")  ;properties columns, maybe
2260                        (org-minutes-to-hh:mm-string (nth 1 tbl))))) ; the time
2261
2262             ;; Get the list of node entries and iterate over it
2263             (setq entries (nth 2 tbl))
2264             (while (setq entry (pop entries))
2265               (setq level (car entry)
2266                     headline (nth 1 entry)
2267                     hlc (if emph (or (cdr (assoc level hlchars)) "") ""))
2268               (when narrow-cut-p
2269                 (if (and (string-match (concat "\\`" org-bracket-link-regexp
2270                                                "\\'")
2271                                        headline)
2272                          (match-end 3))
2273                     (setq headline
2274                           (format "[[%s][%s]]"
2275                                   (match-string 1 headline)
2276                                   (org-shorten-string (match-string 3 headline)
2277                                                       narrow)))
2278                   (setq headline (org-shorten-string headline narrow))))
2279               (insert-before-markers
2280                "|"                      ; start the table line
2281                (if multifile "|" "")    ; free space for file name column?
2282                (if level-p (format "%d|" (car entry)) "")   ; level, maybe
2283                (if timestamp (concat (nth 2 entry) "|") "") ; timestamp, maybe
2284                (if properties
2285                    (concat
2286                     (mapconcat
2287                      (lambda (p) (or (cdr (assoc p (nth 4 entry))) ""))
2288                      properties "|") "|") "")  ;properties columns, maybe
2289                (if indent (org-clocktable-indent-string level) "") ; indentation
2290                hlc headline hlc "|"                                ; headline
2291                (make-string (min (1- ntcol) (or (- level 1))) ?|)
2292                                         ; empty fields for higher levels
2293                hlc (org-minutes-to-hh:mm-string (nth 3 entry)) hlc ; time
2294                "|\n"                                               ; close line
2295                )))))
2296       (backward-delete-char 1)
2297       (if (setq formula (plist-get params :formula))
2298           (cond
2299            ((eq formula '%)
2300             ;; compute the column where the % numbers need to go
2301             (setq pcol (+ 2
2302                           (if multifile 1 0)
2303                           (if level-p 1 0)
2304                           (if timestamp 1 0)
2305                           (min maxlevel (or ntcol 100))))
2306             ;; compute the column where the total time is
2307             (setq tcol (+ 2
2308                           (if multifile 1 0)
2309                           (if level-p 1 0)
2310                           (if timestamp 1 0)))
2311             (insert
2312              (format
2313               "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
2314               pcol            ; the column where the % numbers should go
2315               (if (and narrow (not narrow-cut-p)) 3 2) ; row of the total time
2316               tcol            ; column of the total time
2317               tcol (1- pcol)  ; range of columns where times can be found
2318               ))
2319             (setq recalc t))
2320            ((stringp formula)
2321             (insert "\n#+TBLFM: " formula)
2322             (setq recalc t))
2323            (t (error "invalid formula in clocktable")))
2324         ;; Should we rescue an old formula?
2325         (when (stringp (setq content (plist-get params :content)))
2326           (when (string-match "^\\([ \t]*#\\+TBLFM:.*\\)" content)
2327             (setq recalc t)
2328             (insert "\n" (match-string 1 (plist-get params :content)))
2329             (beginning-of-line 0))))
2330       ;; Back to beginning, align the table, recalculate if necessary
2331       (goto-char ipos)
2332       (skip-chars-forward "^|")
2333       (org-table-align)
2334       (when org-hide-emphasis-markers
2335         ;; we need to align a second time
2336         (org-table-align))
2337       (when recalc
2338         (if (eq formula '%)
2339             (save-excursion
2340               (if (and narrow (not narrow-cut-p)) (beginning-of-line 2))
2341               (org-table-goto-column pcol nil 'force)
2342               (insert "%")))
2343         (org-table-recalculate 'all))
2344       (when rm-file-column
2345         ;; The file column is actually not wanted
2346         (forward-char 1)
2347         (org-table-delete-column))
2348       total-time))
2349
2350 (defun org-clocktable-indent-string (level)
2351   (if (= level 1)
2352       ""
2353     (let ((str "\\__"))
2354       (while (> level 2)
2355         (setq level (1- level)
2356               str (concat str "___")))
2357       (concat str " "))))
2358
2359 (defun org-clocktable-steps (params)
2360   "Step through the range to make a number of clock tables."
2361   (let* ((p1 (copy-sequence params))
2362          (ts (plist-get p1 :tstart))
2363          (te (plist-get p1 :tend))
2364          (step0 (plist-get p1 :step))
2365          (step (cdr (assoc step0 '((day . 86400) (week . 604800)))))
2366          (stepskip0 (plist-get p1 :stepskip0))
2367          (block (plist-get p1 :block))
2368          cc range-text step-time)
2369     (when block
2370       (setq cc (org-clock-special-range block nil t)
2371             ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
2372     (cond
2373      ((numberp ts)
2374       ;; If ts is a number, it's an absolute day number from org-agenda.
2375       (destructuring-bind (month day year) (calendar-gregorian-from-absolute ts)
2376         (setq ts (org-float-time (encode-time 0 0 0 day month year)))))
2377      (ts
2378       (setq ts (org-float-time
2379                 (apply 'encode-time (org-parse-time-string ts))))))
2380     (cond
2381      ((numberp te)
2382       ;; Likewise for te.
2383       (destructuring-bind (month day year) (calendar-gregorian-from-absolute te)
2384         (setq te (org-float-time (encode-time 0 0 0 day month year)))))
2385      (te
2386       (setq te (org-float-time
2387                 (apply 'encode-time (org-parse-time-string te))))))
2388     (setq p1 (plist-put p1 :header ""))
2389     (setq p1 (plist-put p1 :step nil))
2390     (setq p1 (plist-put p1 :block nil))
2391     (while (< ts te)
2392       (or (bolp) (insert "\n"))
2393       (setq p1 (plist-put p1 :tstart (format-time-string
2394                                       (org-time-stamp-format nil t)
2395                                       (seconds-to-time ts))))
2396       (setq p1 (plist-put p1 :tend (format-time-string
2397                                     (org-time-stamp-format nil t)
2398                                     (seconds-to-time (setq ts (+ ts step))))))
2399       (insert "\n" (if (eq step0 'day) "Daily report: "
2400                      "Weekly report starting on: ")
2401               (plist-get p1 :tstart) "\n")
2402       (setq step-time (org-dblock-write:clocktable p1))
2403       (re-search-forward "^[ \t]*#\\+END:")
2404       (when (and (equal step-time 0) stepskip0)
2405         ;; Remove the empty table
2406         (delete-region (point-at-bol)
2407                        (save-excursion
2408                          (re-search-backward "^\\(Daily\\|Weekly\\) report"
2409                                              nil t)
2410                          (point))))
2411       (end-of-line 0))))
2412
2413 (defun org-clock-get-table-data (file params)
2414   "Get the clocktable data for file FILE, with parameters PARAMS.
2415 FILE is only for identification - this function assumes that
2416 the correct buffer is current, and that the wanted restriction is
2417 in place.
2418 The return value will be a list with the file name and the total
2419 file time (in minutes) as 1st and 2nd elements.  The third element
2420 of this list will be a list of headline entries.  Each entry has the
2421 following structure:
2422
2423   (LEVEL HEADLINE TIMESTAMP TIME)
2424
2425 LEVEL:     The level of the headline, as an integer.  This will be
2426            the reduced leve, so 1,2,3,... even if only odd levels
2427            are being used.
2428 HEADLINE:  The text of the headline.  Depending on PARAMS, this may
2429            already be formatted like a link.
2430 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2431            entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2432            in this sequence.
2433 TIME:      The sum of all time spend in this tree, in minutes.  This time
2434            will of cause be restricted to the time block and tags match
2435            specified in PARAMS."
2436   (let* ((maxlevel (or (plist-get params :maxlevel) 3))
2437          (timestamp (plist-get params :timestamp))
2438          (ts (plist-get params :tstart))
2439          (te (plist-get params :tend))
2440          (block (plist-get params :block))
2441          (link (plist-get params :link))
2442          (tags (plist-get params :tags))
2443          (properties (plist-get params :properties))
2444          (inherit-property-p (plist-get params :inherit-props))
2445          (matcher (if tags (cdr (org-make-tags-matcher tags))))
2446          cc range-text st p time level hdl props tsp tbl)
2447
2448     (setq org-clock-file-total-minutes nil)
2449     (when block
2450       (setq cc (org-clock-special-range block nil t)
2451             ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
2452     (when (integerp ts) (setq ts (calendar-gregorian-from-absolute ts)))
2453     (when (integerp te) (setq te (calendar-gregorian-from-absolute te)))
2454     (when (and ts (listp ts))
2455       (setq ts (format "%4d-%02d-%02d" (nth 2 ts) (car ts) (nth 1 ts))))
2456     (when (and te (listp te))
2457       (setq te (format "%4d-%02d-%02d" (nth 2 te) (car te) (nth 1 te))))
2458     ;; Now the times are strings we can parse.
2459     (if ts (setq ts (org-float-time
2460                      (apply 'encode-time (org-parse-time-string ts)))))
2461     (if te (setq te (org-float-time
2462                      (apply 'encode-time (org-parse-time-string te)))))
2463     (save-excursion
2464       (org-clock-sum ts te
2465                      (unless (null matcher)
2466                        (lambda ()
2467                          (let ((tags-list (org-get-tags-at)))
2468                            (eval matcher)))))
2469       (goto-char (point-min))
2470       (setq st t)
2471       (while (or (and (bobp) (prog1 st (setq st nil))
2472                       (get-text-property (point) :org-clock-minutes)
2473                       (setq p (point-min)))
2474                  (setq p (next-single-property-change
2475                           (point) :org-clock-minutes)))
2476         (goto-char p)
2477         (when (setq time (get-text-property p :org-clock-minutes))
2478           (save-excursion
2479             (beginning-of-line 1)
2480             (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
2481                        (setq level (org-reduced-level
2482                                     (- (match-end 1) (match-beginning 1))))
2483                        (<= level maxlevel))
2484               (setq hdl (if (not link)
2485                             (match-string 2)
2486                           (org-make-link-string
2487                            (format "file:%s::%s"
2488                                    (buffer-file-name)
2489                                    (save-match-data
2490                                      (org-make-org-heading-search-string
2491                                       (match-string 2))))
2492                            (match-string 2)))
2493                     tsp (when timestamp
2494                           (setq props (org-entry-properties (point)))
2495                           (or (cdr (assoc "SCHEDULED" props))
2496                               (cdr (assoc "DEADLINE" props))
2497                               (cdr (assoc "TIMESTAMP" props))
2498                               (cdr (assoc "TIMESTAMP_IA" props))))
2499             props (when properties
2500                     (remove nil
2501                             (mapcar
2502                              (lambda (p)
2503                                (when (org-entry-get (point) p inherit-property-p)
2504                                  (cons p (org-entry-get (point) p inherit-property-p))))
2505                              properties))))
2506               (when (> time 0) (push (list level hdl tsp time props) tbl))))))
2507       (setq tbl (nreverse tbl))
2508       (list file org-clock-file-total-minutes tbl))))
2509
2510 (defun org-clock-time% (total &rest strings)
2511   "Compute a time fraction in percent.
2512 TOTAL s a time string like 10:21 specifying the total times.
2513 STRINGS is a list of strings that should be checked for a time.
2514 The first string that does have a time will be used.
2515 This function is made for clock tables."
2516   (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
2517         tot s)
2518     (save-match-data
2519       (catch 'exit
2520         (if (not (string-match re total))
2521             (throw 'exit 0.)
2522           (setq tot (+ (string-to-number (match-string 2 total))
2523                        (* 60 (string-to-number (match-string 1 total)))))
2524           (if (= tot 0.) (throw 'exit 0.)))
2525         (while (setq s (pop strings))
2526           (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
2527               (throw 'exit
2528                      (/ (* 100.0 (+ (string-to-number (match-string 2 s))
2529                                     (* 60 (string-to-number
2530                                            (match-string 1 s)))))
2531                         tot))))
2532         0))))
2533
2534 ;; Saving and loading the clock
2535
2536 (defvar org-clock-loaded nil
2537   "Was the clock file loaded?")
2538
2539 (defun org-clock-save ()
2540   "Persist various clock-related data to disk.
2541 The details of what will be saved are regulated by the variable
2542 `org-clock-persist'."
2543   (when (and org-clock-persist
2544              (or org-clock-loaded
2545                  org-clock-has-been-used
2546                  (not (file-exists-p org-clock-persist-file))))
2547     (let (b)
2548       (with-current-buffer (find-file (expand-file-name org-clock-persist-file))
2549         (progn
2550           (delete-region (point-min) (point-max))
2551           ;;Store clock
2552           (insert (format ";; org-persist.el - %s at %s\n"
2553                           system-name (format-time-string
2554                                        (cdr org-time-stamp-formats))))
2555           (if (and (memq org-clock-persist '(t clock))
2556                    (setq b (org-clocking-buffer))
2557                    (setq b (or (buffer-base-buffer b) b))
2558                    (buffer-live-p b)
2559                    (buffer-file-name b)
2560                    (or (not org-clock-persist-query-save)
2561                        (y-or-n-p (concat "Save current clock ("
2562                                          (substring-no-properties
2563                                           org-clock-heading)
2564                                          ") "))))
2565               (insert "(setq resume-clock '(\""
2566                       (buffer-file-name (org-clocking-buffer))
2567                       "\" . " (int-to-string (marker-position org-clock-marker))
2568                       "))\n"))
2569           ;; Store clocked task history. Tasks are stored reversed to make
2570           ;; reading simpler
2571           (when (and (memq org-clock-persist '(t history))
2572                      org-clock-history)
2573             (insert
2574              "(setq stored-clock-history '("
2575              (mapconcat
2576               (lambda (m)
2577                 (when (and (setq b (marker-buffer m))
2578                            (setq b (or (buffer-base-buffer b) b))
2579                            (buffer-live-p b)
2580                            (buffer-file-name b))
2581                   (concat "(\"" (buffer-file-name b)
2582                           "\" . " (int-to-string (marker-position m))
2583                           ")")))
2584               (reverse org-clock-history) " ") "))\n"))
2585           (save-buffer)
2586           (kill-buffer (current-buffer)))))))
2587
2588 (defun org-clock-load ()
2589   "Load clock-related data from disk, maybe resuming a stored clock."
2590   (when (and org-clock-persist (not org-clock-loaded))
2591     (let ((filename (expand-file-name org-clock-persist-file))
2592           (org-clock-in-resume 'auto-restart)
2593           resume-clock stored-clock-history)
2594       (if (not (file-readable-p filename))
2595           (message "Not restoring clock data; %s not found"
2596                    org-clock-persist-file)
2597         (message "%s" "Restoring clock data")
2598         (setq org-clock-loaded t)
2599         (load-file filename)
2600         ;; load history
2601         (when stored-clock-history
2602           (save-window-excursion
2603             (mapc (lambda (task)
2604                     (if (file-exists-p (car task))
2605                         (org-clock-history-push (cdr task)
2606                                                 (find-file (car task)))))
2607                   stored-clock-history)))
2608         ;; resume clock
2609         (when (and resume-clock org-clock-persist
2610                    (file-exists-p (car resume-clock))
2611                    (or (not org-clock-persist-query-resume)
2612                        (y-or-n-p
2613                         (concat
2614                          "Resume clock ("
2615                          (with-current-buffer (find-file (car resume-clock))
2616                            (save-excursion
2617                              (goto-char (cdr resume-clock))
2618                              (org-back-to-heading t)
2619                              (and (looking-at org-complex-heading-regexp)
2620                                   (match-string 4))))
2621                          ") "))))
2622           (when (file-exists-p (car resume-clock))
2623             (with-current-buffer (find-file (car resume-clock))
2624               (goto-char (cdr resume-clock))
2625               (let ((org-clock-auto-clock-resolution nil))
2626                 (org-clock-in)
2627                 (if (outline-invisible-p)
2628                     (org-show-context))))))))))
2629
2630 ;;;###autoload
2631 (defun org-clock-persistence-insinuate ()
2632   "Set up hooks for clock persistence."
2633   (add-hook 'org-mode-hook 'org-clock-load)
2634   (add-hook 'kill-emacs-hook 'org-clock-save))
2635
2636 ;; Suggested bindings
2637 (org-defkey org-mode-map "\C-c\C-x\C-e" 'org-clock-modify-effort-estimate)
2638
2639 (provide 'org-clock)
2640
2641 ;; arch-tag: 7b42c5d4-9b36-48be-97c0-66a869daed4c
2642
2643 ;;; org-clock.el ends here
2644