org-mhe.el 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. ;;; org-mhe.el --- Support for Links to MH-E Messages -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2004-2018 Free Software Foundation, Inc.
  3. ;; Author: Thomas Baumann <thomas dot baumann at ch dot tum dot de>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: https://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs 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.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file implements links to MH-E messages from within Org.
  23. ;; Org mode loads this module by default - if this is not what you want,
  24. ;; configure the variable `org-modules'.
  25. ;;; Code:
  26. (require 'org-macs)
  27. (require 'org)
  28. ;; Customization variables
  29. (defcustom org-mhe-search-all-folders nil
  30. "Non-nil means the search for the mh-message may extend to all folders.
  31. When non-nil, the search for a message will extend to all other
  32. folders if it cannot be found in the folder given in the link.
  33. Searching all folders may be slow with the default pick based
  34. search but is very efficient with one of the other search engines
  35. supported by MH-E."
  36. :group 'org-link-follow
  37. :type 'boolean)
  38. ;; Declare external functions and variables
  39. (declare-function mh-display-msg "mh-show" (msg-num folder-name))
  40. (declare-function mh-find-path "mh-utils" ())
  41. (declare-function mh-get-header-field "mh-utils" (field))
  42. (declare-function mh-get-msg-num "mh-utils" (error-if-no-message))
  43. (declare-function mh-header-display "mh-show" ())
  44. (declare-function mh-index-previous-folder "mh-search" ())
  45. (declare-function mh-normalize-folder-name "mh-utils"
  46. (folder &optional empty-string-okay dont-remove-trailing-slash
  47. return-nil-if-folder-empty))
  48. (declare-function mh-search "mh-search"
  49. (folder search-regexp &optional redo-search-flag
  50. window-config))
  51. (declare-function mh-search-choose "mh-search" (&optional searcher))
  52. (declare-function mh-show "mh-show" (&optional message redisplay-flag))
  53. (declare-function mh-show-buffer-message-number "mh-comp" (&optional buffer))
  54. (declare-function mh-show-header-display "mh-show" t t)
  55. (declare-function mh-show-msg "mh-show" (msg))
  56. (declare-function mh-show-show "mh-show" t t)
  57. (declare-function mh-visit-folder "mh-folder" (folder &optional
  58. range index-data))
  59. (defvar mh-progs)
  60. (defvar mh-current-folder)
  61. (defvar mh-show-folder-buffer)
  62. (defvar mh-index-folder)
  63. (defvar mh-searcher)
  64. (defvar mh-search-regexp-builder)
  65. ;; Install the link type
  66. (org-link-set-parameters "mhe" :follow #'org-mhe-open :store #'org-mhe-store-link)
  67. ;; Implementation
  68. (defun org-mhe-store-link ()
  69. "Store a link to an MH-E folder or message."
  70. (when (or (eq major-mode 'mh-folder-mode)
  71. (eq major-mode 'mh-show-mode))
  72. (save-window-excursion
  73. (let* ((from (org-mhe-get-header "From:"))
  74. (to (org-mhe-get-header "To:"))
  75. (message-id (org-mhe-get-header "Message-Id:"))
  76. (subject (org-mhe-get-header "Subject:"))
  77. (date (org-mhe-get-header "Date:"))
  78. link desc)
  79. (org-store-link-props :type "mh" :from from :to to :date date
  80. :subject subject :message-id message-id)
  81. (setq desc (org-email-link-description))
  82. (setq link (concat "mhe:" (org-mhe-get-message-real-folder) "#"
  83. (org-unbracket-string "<" ">" message-id)))
  84. (org-add-link-props :link link :description desc)
  85. link))))
  86. (defun org-mhe-open (path)
  87. "Follow an MH-E message link specified by PATH."
  88. (let (folder article)
  89. (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
  90. (error "Error in MH-E link"))
  91. (setq folder (match-string 1 path)
  92. article (match-string 3 path))
  93. (org-mhe-follow-link folder article)))
  94. ;;; mh-e integration based on planner-mode
  95. (defun org-mhe-get-message-real-folder ()
  96. "Return the name of the real folder for the current message.
  97. So if you use sequences, it will now work."
  98. (save-excursion
  99. (let* ((folder
  100. (if (eq major-mode 'mh-folder-mode)
  101. mh-current-folder
  102. ;; Refer to the show buffer
  103. mh-show-folder-buffer))
  104. (end-index
  105. (if (boundp 'mh-index-folder)
  106. (min (length mh-index-folder) (length folder))))
  107. )
  108. ;; a simple test on mh-index-data does not work, because
  109. ;; mh-index-data is always nil in a show buffer.
  110. (if (and (boundp 'mh-index-folder)
  111. (string= mh-index-folder (substring folder 0 end-index)))
  112. (if (eq major-mode 'mh-show-mode)
  113. (save-window-excursion
  114. (let (pop-up-frames)
  115. (when (buffer-live-p (get-buffer folder))
  116. (progn
  117. (pop-to-buffer folder)
  118. (org-mhe-get-message-folder-from-index)
  119. )
  120. )))
  121. (org-mhe-get-message-folder-from-index)
  122. )
  123. folder
  124. )
  125. )))
  126. (defun org-mhe-get-message-folder-from-index ()
  127. "Return the name of the message folder in an index folder buffer."
  128. (save-excursion
  129. (mh-index-previous-folder)
  130. (if (re-search-forward "^\\(+.*\\)$" nil t)
  131. (message "%s" (match-string 1)))))
  132. (defun org-mhe-get-message-folder ()
  133. "Return the name of the current message folder.
  134. Be careful if you use sequences."
  135. (save-excursion
  136. (if (eq major-mode 'mh-folder-mode)
  137. mh-current-folder
  138. ;; Refer to the show buffer
  139. mh-show-folder-buffer)))
  140. (defun org-mhe-get-message-num ()
  141. "Return the number of the current message.
  142. Be careful if you use sequences."
  143. (save-excursion
  144. (if (eq major-mode 'mh-folder-mode)
  145. (mh-get-msg-num nil)
  146. ;; Refer to the show buffer
  147. (mh-show-buffer-message-number))))
  148. (defun org-mhe-get-header (header)
  149. "Return the field for HEADER of the message in folder mode.
  150. This will create a show buffer for the corresponding message. If
  151. you have a better idea of how to do this then please let us know."
  152. (let* ((folder (org-mhe-get-message-folder))
  153. (num (org-mhe-get-message-num))
  154. (buffer (get-buffer-create (concat "show-" folder)))
  155. (header-field))
  156. (with-current-buffer buffer
  157. (mh-display-msg num folder)
  158. (if (eq major-mode 'mh-folder-mode)
  159. (mh-header-display)
  160. (mh-show-header-display))
  161. (set-buffer buffer)
  162. (setq header-field (mh-get-header-field header))
  163. (if (eq major-mode 'mh-folder-mode)
  164. (mh-show)
  165. (mh-show-show))
  166. (org-trim header-field))))
  167. (defun org-mhe-follow-link (folder article)
  168. "Follow an MH-E link to FOLDER and ARTICLE.
  169. If ARTICLE is nil FOLDER is shown. If the configuration variable
  170. `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
  171. ARTICLE is searched in all folders. Indexed searches (swish++,
  172. namazu, and others supported by MH-E) will always search in all
  173. folders."
  174. (require 'mh-e)
  175. (require 'mh-search)
  176. (require 'mh-utils)
  177. (mh-find-path)
  178. (if (not article)
  179. (mh-visit-folder (mh-normalize-folder-name folder))
  180. (mh-search-choose)
  181. (if (eq mh-searcher 'pick)
  182. (progn
  183. (setq article (org-add-angle-brackets article))
  184. (mh-search folder (list "--message-id" article))
  185. (when (and org-mhe-search-all-folders
  186. (not (org-mhe-get-message-real-folder)))
  187. (kill-buffer)
  188. (mh-search "+" (list "--message-id" article))))
  189. (if mh-search-regexp-builder
  190. (mh-search "+" (funcall mh-search-regexp-builder
  191. (list (cons 'message-id article))))
  192. (mh-search "+" article)))
  193. (if (org-mhe-get-message-real-folder)
  194. (mh-show-msg 1)
  195. (kill-buffer)
  196. (error "Message not found"))))
  197. (provide 'org-mhe)
  198. ;;; org-mhe.el ends here