;;; org-mac-message.el --- Links to Apple Mail.app messages from within Org-mode

;; Copyright (C) 2008-2013 Free Software Foundation, Inc.

;; Authors: John Wiegley <johnw@gnu.org>
;;       Christopher Suckling <suckling at gmail dot com>

;; Keywords: outlines, hypermedia, calendar, wp

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:
;; This file implements links to Apple Mail.app messages from within Org-mode.
;; Org-mode does not load this module by default - if you would actually like
;; this to happen then configure the variable `org-modules'.

;; If you would like to create links to all flagged messages in an
;; Apple Mail.app account, please customize the variable
;; `org-mac-mail-account' and then call one of the following functions:

;; (org-mac-message-insert-selected) copies a formatted list of links to
;; the kill ring.

;; (org-mac-message-insert-selected) inserts at point links to any
;; messages selected in Mail.app.

;; (org-mac-message-insert-flagged) searches within an org-mode buffer
;; for a specific heading, creating it if it doesn't exist.  Any
;; message:// links within the first level of the heading are deleted
;; and replaced with links to flagged messages.

;;; Code:

(require 'org)

(defgroup org-mac-flagged-mail nil
  "Options concerning linking to flagged Mail.app messages."
  :tag "Org Mail.app"
  :group 'org-link)

(defcustom org-mac-mail-account "customize"
  "The Mail.app account in which to search for flagged messages."
  :group 'org-mac-flagged-mail
  :type 'string)

(org-add-link-type "message" 'org-mac-message-open)

;; In mac.c, removed in Emacs 23.
(declare-function do-applescript "org-mac-message" (script))
(unless (fboundp 'do-applescript)
  ;; Need to fake this using shell-command-to-string
  (defun do-applescript (script)
    (let (start cmd return)
      (while (string-match "\n" script)
	(setq script (replace-match "\r" t t script)))
      (while (string-match "'" script start)
	(setq start (+ 2 (match-beginning 0))
	      script (replace-match "\\'" t t script)))
      (setq cmd (concat "osascript -e '" script "'"))
      (setq return (shell-command-to-string cmd))
      (concat "\"" (org-trim return) "\""))))

(defun org-mac-message-open (message-id)
  "Visit the message with the given MESSAGE-ID.
This will use the command `open' with the message URL."
  (start-process (concat "open message:" message-id) nil
		 "open" (concat "message://<" (substring message-id 2) ">")))

(defun as-get-selected-mail ()
  "AppleScript to create links to selected messages in Mail.app."
  (do-applescript
   (concat
    "tell application \"Mail\"\n"
    "set theLinkList to {}\n"
    "set theSelection to selection\n"
    "repeat with theMessage in theSelection\n"
    "set theID to message id of theMessage\n"
    "set theSubject to subject of theMessage\n"
    "set theLink to \"message://\" & theID & \"::split::\" & theSubject & \"\n\"\n"
    "copy theLink to end of theLinkList\n"
    "end repeat\n"
    "return theLinkList as string\n"
    "end tell")))

(defun  as-get-flagged-mail ()
     "AppleScript to create links to flagged messages in all Mail.app accounts"
     ;; Revised use of Growl interface and no need for variable org-mac-mail-account
     (do-applescript
      (concat
       ;; Is Growl running? Use API as recommended at http://growl.info/documentation/applescript-support.php 
       "tell application \"System Events\"\n"
       "set growlIsRunning to (count of (every process whose bundle identifier is \"com.Growl.GrowlHelperApp\")) > 0\n"
       "end tell\n"

       "set theLinkList to {}\n"
       "set isNotRegisteredToGrowl to true\n"
       "tell application \"Mail\"\n"
       "set theAccountList to the name of every account\n"
       "repeat with theMailAccount in theAccountList\n"
       "set theMailboxes to every mailbox of account theMailAccount\n"
       "repeat with aMailbox in theMailboxes\n"
       "set theSelection to (every message in aMailbox whose flagged status = true)\n"
       "repeat with theMessage in theSelection\n"
       "set theID to message id of theMessage\n"
       "set theSubject to subject of theMessage\n"
       "set theLink to \"message://\" & theID & \"::split::\" & theSubject & \"\n\"\n"
       "copy theLink to end of theLinkList\n"
       
       "if growlIsRunning then\n"
       "tell application id \"com.Growl.GrowlHelperApp\"\n"
       "if isNotRegisteredToGrowl then\n"
       "set the allNotificationsList to {\"FlaggedMail\"}\n"
       "set the enabledNotificationsList to allNotificationsList\n"
       "register as application \"FlaggedMail\" all notifications allNotificationsList default notifications enabledNotificationsList icon of application \"Mail\"\n"
       "set isNotRegisteredToGrowl to false\n"
       "end if\n"
       "notify with name \"FlaggedMail\" title \"Importing flagged message\" description theSubject application name \"FlaggedMail\"\n"
       "end tell\n"
       "end if\n"
       
       "end repeat\n"
       "end repeat\n"
       "end repeat\n"
       "end tell\n"
       "return theLinkList as string\n"
       ))
     )

(defun org-mac-message-get-links (&optional select-or-flag)
     "Overridden function.
Create links to the messages currently selected or flagged in Mail.app.
This will use AppleScript to get the message-id and the subject of the
messages in Mail.app and make a link out of it.
When SELECT-OR-FLAG is \"s\", get the selected messages (this is also
the default).  When SELECT-OR-FLAG is \"f\", get the flagged messages.
The Org-syntax text will be pushed to the kill ring, and also returned."
     (interactive "sLink to (s)elected or (f)lagged messages: ")
     (setq select-or-flag (or select-or-flag "s"))
     (let* ((as-link-list
	     (if (string= select-or-flag "s")
		 (progn
		   (message "AppleScript: searching mailboxes for selected message")
		   (as-get-selected-mail))
	       (if (string= select-or-flag "f")
		   (progn      
		     ;; searching for all flagged messages can take tens of seconds
		     ;; so user needs to be told of progress even if Growl is also notifying 
		     (message "AppleScript: searching mailboxes for flagged messages")
		     (as-get-flagged-mail))
		 (error "Please select \"s\" or \"f\""))))
	    (link-list
	     (mapcar
	      (lambda (x) (if (string-match "\\`\"\\(.*\\)\"\\'" x) (setq x (match-string 1 x))) x)
	      (split-string as-link-list "[\r\n]+")))
	    split-link URL description orglink orglink-insert rtn orglink-list)
       (while link-list
	 (setq split-link (split-string (pop link-list) "::split::"))
	 (setq URL (car split-link))
	 (setq description (cadr split-link))
	 (when (not (string= URL ""))
	   (setq orglink (org-make-link-string URL description))
	   (push orglink orglink-list)))
       (setq rtn (mapconcat 'identity orglink-list "\n"))
       (kill-new rtn)
       ;; "searching" message will remain in echo area until replaced
       (message "AppleScript: finished searching mailboxes.")
       rtn))

(defun org-mac-message-insert-selected ()
  "Insert a link to the messages currently selected in Mail.app.
This will use AppleScript to get the message-id and the subject of the
active mail in Mail.app and make a link out of it."
  (interactive)
  (insert (org-mac-message-get-links "s")))

;; The following line is for backward compatibility
(defalias 'org-mac-message-insert-link 'org-mac-message-insert-selected)

(eval-after-load "org-mac-message"
  '(defun org-mac-message-insert-flagged (org-buffer org-heading)
     "Asks for an org buffer and a heading within it, and replace message links.
If heading exists, delete all message:// links within heading's first
level.  If heading doesn't exist, create it at point-max.  Insert
list of message:// links to flagged mail after heading."
     (interactive "bBuffer in which to insert links: \nsHeading after which to insert links: ")
     (with-current-buffer org-buffer
       (goto-char (point-min))
       (let ((isearch-forward t)
	     (message-re "\\[\\[\\(message:\\)\\([^]]+\\)\\]\\(\\[\\([^]]+\\)\\]\\)?\\]"))
	 (if (org-goto-local-search-headings org-heading nil t)
	     (if (not (eobp))
		 (progn
		   (save-excursion
		     ;; delete previously recorded flagged messages
		     (while (re-search-forward
			     message-re (save-excursion (outline-next-heading)) t)
		       (delete-region (match-beginning 0) (match-end 0)))
		     (insert "\n" (org-mac-message-get-links "f")))
		   ;; apparently also delete empty lines.
		   ;; allow for situation where there is no next-heading
		   ;; to avoid previously ocurring Lisp errors
		   (let (
			 (frm (point))
			 (tom (outline-next-heading)))
		     (if (null tom) (setq tom (point-max)))
		     (flush-lines "^$" frm tom)))

	       (insert "\n" (org-mac-message-get-links "f")))
	   (goto-char (point-max))
	   (insert "\n")
	   (org-insert-heading nil t)
	   (insert org-heading "\n" (org-mac-message-get-links "f"))))))
  )

(provide 'org-mac-message)

;;; org-mac-message.el ends here