org-wl.el 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. ;;; org-wl.el --- Support for links to Wanderlust messages from within Org-mode
  2. ;; Copyright (C) 2004-2017 Free Software Foundation, Inc.
  3. ;; Author: Tokuya Kameshima <kames at fa2 dot so-net dot ne dot jp>
  4. ;; David Maus <dmaus at ictsoc dot de>
  5. ;; Keywords: outlines, hypermedia, calendar, wp
  6. ;; Homepage: http://orgmode.org
  7. ;;
  8. ;; This file is not part of GNU Emacs.
  9. ;;
  10. ;; This program is free software: you can redistribute it and/or modify
  11. ;; it under the terms of the GNU General Public License as published by
  12. ;; the Free Software Foundation, either version 3 of the License, or
  13. ;; (at your option) any later version.
  14. ;; This program is distributed in the hope that it will be useful,
  15. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. ;; GNU General Public License for more details.
  18. ;; You should have received a copy of the GNU General Public License
  19. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  20. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  21. ;;
  22. ;;; Commentary:
  23. ;; This file implements links to Wanderlust messages from within Org-mode.
  24. ;; Org-mode loads this module by default - if this is not what you want,
  25. ;; configure the variable `org-modules'.
  26. ;;; Code:
  27. (require 'org)
  28. (defgroup org-wl nil
  29. "Options concerning the Wanderlust link."
  30. :tag "Org Startup"
  31. :group 'org-link)
  32. (defcustom org-wl-link-to-refile-destination t
  33. "Create a link to the refile destination if the message is marked as refile."
  34. :group 'org-wl
  35. :type 'boolean)
  36. (defcustom org-wl-link-remove-filter nil
  37. "Remove filter condition if message is filter folder."
  38. :group 'org-wl
  39. :type 'boolean)
  40. (defcustom org-wl-shimbun-prefer-web-links nil
  41. "If non-nil create web links for shimbun messages."
  42. :group 'org-wl
  43. :type 'boolean)
  44. (defcustom org-wl-nntp-prefer-web-links nil
  45. "If non-nil create web links for nntp messages.
  46. When folder name contains string \"gmane\" link to gmane,
  47. googlegroups otherwise."
  48. :type 'boolean
  49. :group 'org-wl)
  50. (defcustom org-wl-disable-folder-check t
  51. "Disable check for new messages when open a link."
  52. :type 'boolean
  53. :group 'org-wl)
  54. (defcustom org-wl-namazu-default-index nil
  55. "Default namazu search index."
  56. :type '(choice (const nil) (directory))
  57. :group 'org-wl)
  58. ;; Declare external functions and variables
  59. (declare-function elmo-folder-exists-p "ext:elmo" (folder) t)
  60. (declare-function elmo-message-entity-field "ext:elmo-msgdb"
  61. (entity field &optional type))
  62. (declare-function elmo-message-field "ext:elmo"
  63. (folder number field &optional type) t)
  64. (declare-function elmo-msgdb-overview-get-entity "ext:elmo" (id msgdb) t)
  65. ;; Backward compatibility to old version of wl
  66. (declare-function wl "ext:wl" () t)
  67. (declare-function wl-summary-buffer-msgdb "ext:wl-folder" () t)
  68. (declare-function wl-summary-jump-to-msg-by-message-id "ext:wl-summary"
  69. (&optional id))
  70. (declare-function wl-summary-jump-to-msg "ext:wl-summary"
  71. (&optional number beg end))
  72. (declare-function wl-summary-line-from "ext:wl-summary" ())
  73. (declare-function wl-summary-line-subject "ext:wl-summary" ())
  74. (declare-function wl-summary-message-number "ext:wl-summary" ())
  75. (declare-function wl-summary-redisplay "ext:wl-summary" (&optional arg))
  76. (declare-function wl-summary-registered-temp-mark "ext:wl-action" (number))
  77. (declare-function wl-folder-goto-folder-subr "ext:wl-folder"
  78. (&optional folder sticky))
  79. (declare-function wl-folder-get-petname "ext:wl-folder" (name))
  80. (declare-function wl-folder-get-entity-from-buffer "ext:wl-folder"
  81. (&optional getid))
  82. (declare-function wl-folder-buffer-group-p "ext:wl-folder")
  83. (defvar wl-init)
  84. (defvar wl-summary-buffer-elmo-folder)
  85. (defvar wl-summary-buffer-folder-name)
  86. (defvar wl-folder-group-regexp)
  87. (defvar wl-auto-check-folder-name)
  88. (defvar elmo-nntp-default-server)
  89. (defconst org-wl-folder-types
  90. '(("%" . imap) ("-" . nntp) ("+" . mh) ("=" . spool)
  91. ("$" . archive) ("&" . pop) ("@" . shimbun) ("[" . search)
  92. ("*" . multi) ("/" . filter) ("|" . pipe) ("'" . internal))
  93. "List of folder indicators. See Wanderlust manual, section 3.")
  94. ;; Install the link type
  95. (org-link-set-parameters "wl" :follow #'org-wl-open :store #'org-wl-store-link)
  96. ;; Implementation
  97. (defun org-wl-folder-type (folder)
  98. "Return symbol that indicates the type of FOLDER.
  99. FOLDER is the wanderlust folder name. The first character of the
  100. folder name determines the folder type."
  101. (let* ((indicator (substring folder 0 1))
  102. (type (cdr (assoc indicator org-wl-folder-types))))
  103. ;; maybe access or file folder
  104. (when (not type)
  105. (setq type
  106. (cond
  107. ((and (>= (length folder) 5)
  108. (string= (substring folder 0 5) "file:"))
  109. 'file)
  110. ((and (>= (length folder) 7)
  111. (string= (substring folder 0 7) "access:"))
  112. 'access)
  113. (t
  114. nil))))
  115. type))
  116. (defun org-wl-message-field (field entity)
  117. "Return content of FIELD in ENTITY.
  118. FIELD is a symbol of a rfc822 message header field.
  119. ENTITY is a message entity."
  120. (let ((content (elmo-message-entity-field entity field 'string)))
  121. (if (listp content) (car content) content)))
  122. (defun org-wl-store-link ()
  123. "Store a link to a WL message or folder."
  124. (unless (eobp)
  125. (cond
  126. ((memq major-mode '(wl-summary-mode mime-view-mode))
  127. (org-wl-store-link-message))
  128. ((eq major-mode 'wl-folder-mode)
  129. (org-wl-store-link-folder))
  130. (t
  131. nil))))
  132. (defun org-wl-store-link-folder ()
  133. "Store a link to a WL folder."
  134. (let* ((folder (wl-folder-get-entity-from-buffer))
  135. (petname (wl-folder-get-petname folder))
  136. (link (concat "wl:" folder)))
  137. (save-excursion
  138. (beginning-of-line)
  139. (unless (and (wl-folder-buffer-group-p)
  140. (looking-at wl-folder-group-regexp))
  141. (org-store-link-props :type "wl" :description petname
  142. :link link)
  143. link))))
  144. (defun org-wl-store-link-message ()
  145. "Store a link to a WL message."
  146. (save-excursion
  147. (let ((buf (if (eq major-mode 'wl-summary-mode)
  148. (current-buffer)
  149. (and (boundp 'wl-message-buffer-cur-summary-buffer)
  150. wl-message-buffer-cur-summary-buffer))))
  151. (when buf
  152. (with-current-buffer buf
  153. (let* ((msgnum (wl-summary-message-number))
  154. (mark-info (wl-summary-registered-temp-mark msgnum))
  155. (folder-name
  156. (if (and org-wl-link-to-refile-destination
  157. mark-info
  158. (equal (nth 1 mark-info) "o")) ; marked as refile
  159. (nth 2 mark-info)
  160. wl-summary-buffer-folder-name))
  161. (folder-type (org-wl-folder-type folder-name))
  162. (wl-message-entity
  163. (if (fboundp 'elmo-message-entity)
  164. (elmo-message-entity
  165. wl-summary-buffer-elmo-folder msgnum)
  166. (elmo-msgdb-overview-get-entity
  167. msgnum (wl-summary-buffer-msgdb))))
  168. (message-id
  169. (org-wl-message-field 'message-id wl-message-entity))
  170. (message-id-no-brackets
  171. (org-unbracket-string "<" ">" message-id))
  172. (from (org-wl-message-field 'from wl-message-entity))
  173. (to (org-wl-message-field 'to wl-message-entity))
  174. (xref (org-wl-message-field 'xref wl-message-entity))
  175. (subject (org-wl-message-field 'subject wl-message-entity))
  176. (date (org-wl-message-field 'date wl-message-entity))
  177. desc link)
  178. ;; remove text properties of subject string to avoid possible bug
  179. ;; when formatting the subject
  180. ;; (Emacs bug #5306, fixed)
  181. (set-text-properties 0 (length subject) nil subject)
  182. ;; maybe remove filter condition
  183. (when (and (eq folder-type 'filter) org-wl-link-remove-filter)
  184. (while (eq (org-wl-folder-type folder-name) 'filter)
  185. (setq folder-name
  186. (replace-regexp-in-string "^/[^/]+/" "" folder-name))))
  187. ;; maybe create http link
  188. (cond
  189. ((and (eq folder-type 'shimbun)
  190. org-wl-shimbun-prefer-web-links xref)
  191. (org-store-link-props :type "http" :link xref :description subject
  192. :from from :to to :message-id message-id
  193. :message-id-no-brackets message-id-no-brackets
  194. :subject subject))
  195. ((and (eq folder-type 'nntp) org-wl-nntp-prefer-web-links)
  196. (setq link
  197. (format
  198. (if (string-match "gmane\\." folder-name)
  199. "http://mid.gmane.org/%s"
  200. "http://groups.google.com/groups/search?as_umsgid=%s")
  201. (org-fixup-message-id-for-http message-id)))
  202. (org-store-link-props :type "http" :link link :description subject
  203. :from from :to to :message-id message-id
  204. :message-id-no-brackets message-id-no-brackets
  205. :subject subject))
  206. (t
  207. (org-store-link-props :type "wl" :from from :to to
  208. :subject subject :message-id message-id
  209. :message-id-no-brackets message-id-no-brackets)
  210. (setq desc (org-email-link-description))
  211. (setq link (concat "wl:" folder-name "#" message-id-no-brackets))
  212. (org-add-link-props :link link :description desc)))
  213. (org-add-link-props :date date)
  214. (or link xref)))))))
  215. (defun org-wl-open-nntp (path)
  216. "Follow the nntp: link specified by PATH."
  217. (let* ((spec (split-string path "/"))
  218. (server (split-string (nth 2 spec) "@"))
  219. (group (nth 3 spec))
  220. (article (nth 4 spec)))
  221. (org-wl-open
  222. (concat "-" group ":" (if (cdr server)
  223. (car (split-string (car server) ":"))
  224. "")
  225. (if (string= elmo-nntp-default-server (nth 2 spec))
  226. ""
  227. (concat "@" (or (cdr server) (car server))))
  228. (if article (concat "#" article) "")))))
  229. (defun org-wl-open (path)
  230. "Follow the WL message link specified by PATH.
  231. When called with one prefix, open message in namazu search folder
  232. with `org-wl-namazu-default-index' as search index. When called
  233. with two prefixes or `org-wl-namazu-default-index' is nil, ask
  234. for namazu index."
  235. (require 'wl)
  236. (let ((wl-auto-check-folder-name
  237. (if org-wl-disable-folder-check
  238. 'none
  239. wl-auto-check-folder-name)))
  240. (unless wl-init (wl))
  241. ;; XXX: The imap-uw's MH folder names start with "%#".
  242. (if (not (string-match "\\`\\(\\(?:%#\\)?[^#]+\\)\\(#\\(.*\\)\\)?" path))
  243. (error "Error in Wanderlust link"))
  244. (let ((folder (match-string 1 path))
  245. (article (match-string 3 path)))
  246. ;; maybe open message in namazu search folder
  247. (when current-prefix-arg
  248. (setq folder (concat "[" article "]"
  249. (if (and (equal current-prefix-arg '(4))
  250. org-wl-namazu-default-index)
  251. org-wl-namazu-default-index
  252. (read-directory-name "Namazu index: ")))))
  253. (if (not (elmo-folder-exists-p (with-no-warnings
  254. (wl-folder-get-elmo-folder folder))))
  255. (error "No such folder: %s" folder))
  256. (let ((old-buf (current-buffer))
  257. (old-point (point-marker)))
  258. (wl-folder-goto-folder-subr folder)
  259. (with-current-buffer old-buf
  260. ;; XXX: `wl-folder-goto-folder-subr' moves point to the
  261. ;; beginning of the current line. So, restore the point
  262. ;; in the old buffer.
  263. (goto-char old-point))
  264. (when article
  265. (if (string-match-p "@" article)
  266. (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets
  267. article))
  268. (or (wl-summary-jump-to-msg (string-to-number article))
  269. (error "No such message: %s" article)))
  270. (wl-summary-redisplay))))))
  271. (provide 'org-wl)
  272. ;;; org-wl.el ends here