1 ;;; gnorb-org.el --- The Org-centric functions of gnorb
3 ;; Copyright (C) 2014 Eric Abrahamsen
5 ;; Author: Eric Abrahamsen <eric@ericabrahamsen.net>
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
27 (require 'gnorb-utils)
29 (defgroup gnorb-org nil
30 "The Org bits of Gnorb."
34 (defcustom gnorb-org-after-message-setup-hook nil
35 "Hook run in a message buffer after setting up the message from
36 `gnorb-org-handle-mail' or `gnorb-org-email-subtree'."
40 (defcustom gnorb-org-trigger-actions
41 '(("todo state" . todo)
43 ("don't associate" . no-associate)
44 ("only associate" . associate)
45 ; ("capture to child" . cap-child)
46 ; ("capture to sibling" . cap-sib)
48 "List of potential actions that can be taken on headings.
50 When triggering an Org heading after receiving or sending a
51 message, this option lists the possible actions to take. Built-in
54 todo state: Associate the message, and change TODO state.
55 take note: Associate the message, and take a note.
56 don't associate: Do nothing at all, don't connect the message and TODO.
57 only associate: Associate the message with this heading, do nothing else.
58 capture to child: [not yet implemented] Associate this message with a new child heading.
59 capture to sibling: [not yet implemented] Associate this message with a new sibling heading.
61 You can reorder this list or remove items as suits your workflow.
62 The two \"capture\" options will use the value of
63 `gnorb-gnus-new-todo-capture-key' to find the appropriate
66 You can also add custom actions to the list. Actions should be a
67 cons of a string tag and a symbol indicating a custom function.
68 This function will be called on the heading in question, and
69 passed a plist containing information about the message from
70 which we're triggering."
74 (defcustom gnorb-org-msg-id-key "GNORB_MSG_ID"
75 "The name of the org property used to store the Message-IDs
76 from relevant messages. This is no longer used, and will be
81 (defcustom gnorb-org-mail-scan-scope 2
82 "Number of paragraphs to scan for mail-related links.
84 When handling a TODO heading with `gnorb-org-handle-mail', Gnorb
85 will typically reply to the most recent message associated with
86 this heading. If there are no such messages, or message tracking
87 is disabled entirely, or `gnorb-org-handle-mail' has been called
88 with a prefix arg, the heading and body text of the subtree under
89 point will instead be scanned for gnus:, mailto:, and bbdb:
90 links. This option controls how many paragraphs of body text to
91 scan. Set to 0 to only look in the heading.")
93 (make-obsolete-variable
94 'gnorb-org-mail-scan-strategies
95 "This variable has been superseded by `gnorb-org-trigger-actions'"
96 "September 12, 2014" 'set)
98 (make-obsolete-variable
99 'gnorb-org-mail-scan-state-changes
100 "This variable has been superseded by `gnorb-org-trigger-actions'"
101 "September 12, 2014" 'set)
103 (make-obsolete-variable
104 'gnorb-org-mail-scan-function
105 "This variable has been superseded by `gnorb-org-trigger-actions'"
106 "September 12, 2014" 'set)
108 (defcustom gnorb-org-find-candidates-match nil
109 "When scanning all org files for heading related to an incoming
110 message, this option will limit which headings will be offered as
111 target candidates. Specifically it will be used as the second
112 argument to `org-map-entries', and syntax is the same as that
113 used in an agenda tags view."
118 (defun gnorb-org-contact-link (rec)
119 "Prompt for a BBDB record and insert a link to that record at
122 There's really no reason to use this instead of regular old
123 `org-insert-link' with BBDB completion. But there might be in the
125 ;; this needs to handle an active region.
126 (interactive (list (gnorb-prompt-for-bbdb-record)))
127 (let* ((name (bbdb-record-name rec))
128 (link (concat "bbdb:" (org-link-escape name))))
129 (org-store-link-props :type "bbdb" :name name
130 :link link :description name)
131 (if (called-interactively-p 'any)
132 (insert (format "[[%s][%s]]" link name))
135 (defun gnorb-org-restore-after-send ()
136 "After an email is sent, clean up the gnus summary buffer, put
137 us back where we came from, and go through all the org ids that
138 might have been in the outgoing message's headers and call
139 `gnorb-trigger-todo-action' on each one."
140 (delete-other-windows)
141 (dolist (id gnorb-message-org-ids)
144 (gnorb-trigger-todo-action nil id))
145 ;; this is a little unnecessary, but it may save grief
146 (setq gnorb-gnus-message-info nil)
147 (setq gnorb-message-org-ids nil))
149 (defun gnorb-org-extract-links (&optional arg region)
150 "See if there are viable links in the subtree under point."
151 ;; We're not currently using the arg. What could we do with it?
153 ;; If the region was active, only use the region
155 (push (buffer-substring (car region) (cdr region))
157 ;; Otherwise collect the heading text, and all the paragraph
160 (org-narrow-to-subtree)
161 (let ((head (org-element-at-point))
162 (tree (org-element-parse-buffer)))
163 (push (org-element-property
167 (org-element-map tree 'paragraph
169 (push (org-element-interpret-data p)
173 ;; Limit number of paragraphs based on
174 ;; `gnorb-org-mail-scan-scope'
176 (cond ((eq gnorb-org-mail-scan-scope 'all)
178 ((numberp gnorb-org-mail-scan-scope)
181 strings 0 (1+ gnorb-org-mail-scan-scope))))
182 ;; We could provide more options here. 'tree vs
183 ;; 'subtree, for instance.
190 (goto-char (point-min))
191 (gnorb-scan-links (point-max) 'gnus 'mail 'bbdb)))))
193 (defun gnorb-org-extract-mail-stuff (&optional arg region)
194 "Decide how to hande the Org heading under point as an email task.
196 See the docstring of `gnorb-org-handle-mail' for details."
197 (if (or (not gnorb-tracking-enabled)
199 (gnorb-org-extract-links arg region)
200 ;; Get all the messages associated with the IDS in this subtree.
205 (gnorb-registry-org-id-search id))
206 (gnorb-collect-ids)))))
207 (gnorb-org-extract-mail-tracking assoc-msg-ids arg region))))
209 (defun gnorb-org-extract-mail-tracking (assoc-msg-ids &optional arg region)
211 (let* ((all-links (gnorb-org-extract-links nil region))
212 ;; The latest (by the creation-time registry key) of all the
213 ;; tracked messages that were not sent by our user.
220 (let ((from (car (gnus-registry-get-id-key m 'sender))))
223 user-mail-address from)
225 message-alternative-emails from))))
229 (car (gnus-registry-get-id-key l 'creation-time))
230 (car (gnus-registry-get-id-key r 'creation-time)))))))))
232 ;; If there are no tracked messages, or the user has specifically
233 ;; requested we ignore them with the prefix arg, just return the
234 ;; found links in the subtree.
236 (null latest-msg-id))
238 ;; Otherwise ignore the other links in the subtree, and return
239 ;; the latest message.
241 `(:gnus ,(list (gnorb-msg-id-to-link latest-msg-id)))))))
243 (defun gnorb-org-setup-message
244 (&optional messages mails from cc bcc attachments text ids)
245 "Common message setup routine for other gnorb-org commands.
246 MESSAGES is a list of gnus links pointing to messages -- we
247 currently only use the first of the list. MAILS is a list of
248 email address strings suitable for inserting in the To header.
249 ATTACHMENTS is a list of filenames to attach. TEXT is a string or
250 buffer, which is inserted in the message body. IDS is one or more
251 Org heading ids, associating the outgoing message with those
253 (require 'gnorb-gnus)
255 ;; Either compose new message...
256 (compose-mail (mapconcat 'identity mails ", "))
257 ;; ...or follow link and start reply.
259 (let ((ret-val (org-gnus-open (org-link-unescape (car messages)))))
260 ;; We failed to open the link (probably), ret-val would be
262 (when (stringp ret-val)
265 'gnus-summary-wide-reply-with-original)
266 ;; Add MAILS to message To header.
270 (insert (mapconcat 'identity mails ", "))))
271 (error (when (and (window-configuration-p gnorb-window-conf)
273 (set-window-configuration gnorb-window-conf)
274 (goto-char gnorb-return-marker))
275 (signal (car err) (cdr err)))))
276 ;; Return us after message is sent.
277 (add-to-list 'message-exit-actions
278 'gnorb-org-restore-after-send t)
279 ;; Set headers from MAIL_* properties (from, cc, and bcc).
282 (funcall (intern (format "message-goto-%s" (car h))))
283 (let ((message-beginning-of-line t)
284 (show-trailing-whitespace t))
285 (message-beginning-of-line)
289 (dolist (h `((from . ,from) (cc . ,cc) (bcc . ,bcc)))
291 ;; attach ATTACHMENTS
293 (lambda (a) (format "Attach %s to outgoing message? "
294 (file-name-nondirectory a)))
296 (mml-attach-file a (mm-default-file-encoding a)
299 '("file" "files" "attach"))
300 ;; insert text, if any
305 (insert-buffer-substring text)
307 ;; insert org ids, if any
310 (setq ids (list ids)))
313 (message-narrow-to-headers)
315 (goto-char (point-at-bol))
317 ;; this function hardly does anything
318 (message-insert-header
319 (intern gnorb-mail-header) i)))))
320 ;; put point somewhere reasonable
321 (if (or mails messages)
323 (message-goto-subject)
326 (run-hooks 'gnorb-org-after-message-setup-hook))
328 (defun gnorb-org-attachment-list (&optional id)
329 "Get a list of files (absolute filenames) attached to the
330 current heading, or the heading indicated by optional argument ID."
331 (when (featurep 'org-attach)
332 (let* ((attach-dir (save-excursion
339 (expand-file-name f attach-dir))
340 (org-attach-file-list attach-dir))))
344 (defun gnorb-org-handle-mail (&optional arg text file)
345 "Handle current headline as a mail TODO.
347 How this function behaves depends on whether you're using Gnorb
348 for email tracking, also on the prefix arg, and on the active
351 If tracking is enabled and there is no prefix arg, Gnorb will
352 begin a reply to the newest associated message that wasn't sent
353 by the user -- ie, the Sender header doesn't match
354 `user-mail-address' or `message-alternative-emails'.
356 If tracking is enabled and there is a prefix arg, ignore the
357 tracked messages and instead scan the subtree for mail-related
358 links. This means links prefixed with gnus:, mailto:, or bbdb:.
359 See `gnorb-org-mail-scan-scope' to limit the scope of this scan.
360 Do something appropriate with the resulting links.
362 With a double prefix arg, ignore all tracked messages and all
363 links, and compose a blank new message.
365 If tracking is enabled and you want to reply to a
366 specific (earlier) message in the tracking history, use
367 `gnorb-org-view' to open an nnir *Summary* buffer containing all
368 the messages, and reply to the one you want. Your reply will be
369 automatically tracked, as well.
371 If tracking is not enabled and you want to use a specific link in
372 the subtree as a basis for the email action, then put the region
373 around that link before you call this message."
375 (setq gnorb-window-conf (current-window-configuration))
376 (move-marker gnorb-return-marker (point))
377 (when (eq major-mode 'org-agenda-mode)
378 ;; If this is all the different types, we could skip the check.
379 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
380 (org-agenda-check-no-diary)
381 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
383 (buffer (marker-buffer marker))
384 (pos (marker-position marker)))
385 (switch-to-buffer buffer)
390 (cons (region-beginning) (region-end)))))
393 (unless (org-back-to-heading t)
394 (error "Not in an org item"))
395 (cl-flet ((mp (p) (org-entry-get (point) p t)))
396 ;; Double prefix means ignore everything and compose a blank
398 (let* ((links (unless (equal arg '(16))
399 (gnorb-org-extract-mail-stuff arg region)))
400 (attachments (gnorb-org-attachment-list))
401 (from (mp "MAIL_FROM"))
403 (bcc (mp "MAIL_BCC"))
404 (org-id (org-id-get-create))
405 (recs (plist-get links :bbdb))
406 (message-mode-hook (copy-sequence message-mode-hook))
409 (cons file attachments))
415 (car (bbdb-message-search
416 (org-link-unescape r)
421 (push (bbdb-mail-address r) mails)))
423 gnorb-bbdb-posting-styles)
424 (add-hook 'message-mode-hook
426 (gnorb-bbdb-configure-posting-styles (cdr recs))
427 (gnorb-bbdb-configure-posting-styles (list (car recs))))))
428 (gnorb-org-setup-message
429 (plist-get links :gnus)
430 (append mails (plist-get links :mail))
432 attachments text org-id))))))
436 (defcustom gnorb-org-email-subtree-text-parameters nil
437 "A plist of export parameters corresponding to the EXT-PLIST
438 argument to the export functions, for use when exporting to
443 (defcustom gnorb-org-email-subtree-file-parameters nil
444 "A plist of export parameters corresponding to the EXT-PLIST
445 argument to the export functions, for use when exporting to a
450 (defcustom gnorb-org-email-subtree-text-options '(nil t nil t)
451 "A list of ts and nils corresponding to Org's export options,
452 to be used when exporting to text. The options, in order, are
453 async, subtreep, visible-only, and body-only."
457 (defcustom gnorb-org-email-subtree-file-options '(nil t nil nil)
458 "A list of ts and nils corresponding to Org's export options,
459 to be used when exporting to a file. The options, in order, are
460 async, subtreep, visible-only, and body-only."
464 (defcustom gnorb-org-export-extensions
472 (odt ".odt") ; not really, though
475 "Correspondence between export backends and their
476 respective (usual) file extensions. Ugly way to do it, but what
481 (defun gnorb-org-email-subtree (&optional arg)
482 "Call on a subtree to export it either to a text string or a file,
483 then compose a mail message either with the exported text
484 inserted into the message body, or the exported file attached to
487 Export options default to the following: When exporting to a
488 buffer: async = nil, subtreep = t, visible-only = nil, body-only
489 = t. Options are the same for files, except body-only is set to
490 nil. Customize `gnorb-org-email-subtree-text-options' and
491 `gnorb-org-email-subtree-file-options', respectively.
493 Customize `gnorb-org-email-subtree-parameters' to your preferred
494 default set of parameters."
495 ;; I sure would have liked to use the built-in dispatch ui, but it's
496 ;; got too much hard-coded stuff.
498 (org-back-to-heading t)
499 (let* ((backend-string
503 (symbol-name (org-export-backend-name b)))
504 org-export--registered-backends) nil t))
505 (backend-symbol (intern backend-string))
506 (f-or-t (org-completing-read "Export as file or text? "
507 '("file" "text") nil t))
508 (org-export-show-temporary-export-buffer nil)
509 (opts (if (equal f-or-t "text")
510 gnorb-org-email-subtree-text-options
511 gnorb-org-email-subtree-file-options))
513 (if (equal f-or-t "text")
514 (apply 'org-export-to-buffer
518 ,gnorb-org-email-subtree-text-parameters))
519 (apply 'org-export-to-file
521 ,(org-export-output-file-name
522 (second (assoc backend-symbol gnorb-org-export-extensions))
525 ,gnorb-org-email-subtree-file-parameters))))
527 (setq gnorb-window-conf (current-window-configuration))
528 (move-marker gnorb-return-marker (point))
532 (gnorb-org-handle-mail arg text file)))
534 (defcustom gnorb-org-capture-collect-link-p t
535 "Should the capture process store a link to the gnus message or
536 BBDB record under point, even if it's not part of the template?
537 You'll probably end up needing it, anyway."
540 (defun gnorb-org-capture-collect-link ()
541 (when gnorb-org-capture-collect-link-p
542 (let ((buf (org-capture-get :original-buffer)))
544 (with-current-buffer buf
545 (when (memq major-mode '(gnus-summary-mode
548 (call-interactively 'org-store-link)))))))
550 (add-hook 'org-capture-mode-hook 'gnorb-org-capture-collect-link)
552 ;;; Agenda/BBDB popup stuff
554 (defcustom gnorb-org-agenda-popup-bbdb nil
555 "Should Agenda tags search pop up a BBDB buffer with matching
558 Records are considered matching if they have an `org-tags' field
559 matching the current Agenda search. The name of that field can be
560 customized with `gnorb-bbdb-org-tag-field'."
563 (defcustom gnorb-org-bbdb-popup-layout 'pop-up-multi-line
564 "Default BBDB buffer layout for automatic Org Agenda display."
566 :type '(choice (const one-line)
568 (const full-multi-line)
572 (defun gnorb-org-popup-bbdb (&optional str)
573 "In an `org-tags-view' Agenda buffer, pop up a BBDB buffer
574 showing records whose `org-tags' field matches the current tags
576 ;; I was hoping to use `org-make-tags-matcher' directly, then snag
577 ;; the tagmatcher from the resulting value, but there doesn't seem
578 ;; to be a reliable way of only getting the tag-related returns. But
579 ;; I'd still like to use that function. So an ugly hack to first
580 ;; remove non-tag contents from the query string, and then make a
581 ;; new call to `org-make-tags-matcher'.
583 (require 'gnorb-bbdb)
586 (and (eq major-mode 'org-agenda-mode)
587 (eq org-agenda-type 'tags))
588 (or (called-interactively-p 'any)
589 gnorb-org-agenda-popup-bbdb))
590 (let ((todo-only nil)
591 (str (or str org-agenda-query-string))
592 (re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)")
593 or-terms term rest out-or acc tag-clause)
594 (setq or-terms (org-split-string str "|"))
595 (while (setq term (pop or-terms))
597 (while (string-match re term)
598 (setq rest (substring term (match-end 0)))
599 (let ((sub-term (match-string 0 term)))
600 (unless (save-match-data ; this isn't a tag, don't want it
601 (string-match "\\([<>=]\\)" sub-term))
604 (push (mapconcat 'identity (nreverse acc) "") out-or))
605 (setq str (mapconcat 'identity (nreverse out-or) "|"))
606 (setq tag-clause (cdr (org-make-tags-matcher str)))
607 (unless (equal str "")
611 (let ((rec-tags (bbdb-record-xfield
612 r gnorb-bbdb-org-tag-field)))
614 (let ((tags-list (org-split-string rec-tags ":"))
616 (org-trust-scanner-tags t))
617 (eval tag-clause)))))
619 ((eq major-mode 'org-mode)
621 (org-back-to-heading)
622 (let ((bound (org-element-property
623 :end (org-element-at-point)))
625 (while (re-search-forward
626 org-bracket-link-analytic-regexp bound t)
627 (when (string-match-p "bbdb" (match-string 2))
628 (setq desc (match-string 5)
629 rec (bbdb-search (bbdb-records) desc desc desc)
630 recs (append recs rec))))))))
632 (bbdb-display-records
633 recs gnorb-org-bbdb-popup-layout)
634 (when (get-buffer-window bbdb-buffer-name)
636 (get-buffer-window bbdb-buffer-name)))
637 (when (called-interactively-p 'any)
638 (message "No relevant BBDB records")))))
640 (if (featurep 'gnorb-bbdb)
641 (add-hook 'org-agenda-finalize-hook 'gnorb-org-popup-bbdb))
643 ;;; Groups from the gnorb gnus server backend
646 (defun gnorb-org-view ()
647 "Search the subtree at point for links to gnus messages, and
648 then show them in an ephemeral group, in gnus.
650 This won't work unless you've added a \"nngnorb\" server to
651 your gnus select methods."
652 ;; this should also work on the active region, if there is one.
654 (setq gnorb-window-conf (current-window-configuration))
655 (move-marker gnorb-return-marker (point))
656 (when (eq major-mode 'org-agenda-mode)
657 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags)
658 (org-agenda-check-no-diary)
659 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
661 (buffer (marker-buffer marker))
662 (pos (marker-position marker)))
663 (switch-to-buffer buffer)
668 (org-back-to-heading)
669 (setq id (concat "id+" (org-id-get-create))))
670 (gnorb-gnus-search-messages
672 `(when (and (window-configuration-p gnorb-window-conf)
674 (set-window-configuration gnorb-window-conf)
675 (goto-char gnorb-return-marker)))))
678 ;;; gnorb-org.el ends here