lisp/org/org-vm.el

   1 ;;; org-vm.el --- Support for links to VM messages from within Org-mode
   2
   3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
   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: 6.33x
  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 ;; This file implements links to VM messages and folders from within Org-mode.
  29 ;; Org-mode loads this module by default - if this is not what you want,
  30 ;; configure the variable `org-modules'.
  31
  32 ;;; Code:
  33
  34 (require 'org)
  35
  36 ;; Declare external functions and variables
  37 (declare-function vm-preview-current-message "ext:vm-page" ())
  38 (declare-function vm-follow-summary-cursor "ext:vm-motion" ())
  39 (declare-function vm-get-header-contents "ext:vm-summary"
  40                   (message header-name-regexp &optional clump-sep))
  41 (declare-function vm-isearch-narrow "ext:vm-search" ())
  42 (declare-function vm-isearch-update "ext:vm-search" ())
  43 (declare-function vm-select-folder-buffer "ext:vm-macro" ())
  44 (declare-function vm-su-message-id "ext:vm-summary" (m))
  45 (declare-function vm-su-subject "ext:vm-summary" (m))
  46 (declare-function vm-summarize "ext:vm-summary" (&optional display raise))
  47 (defvar vm-message-pointer)
  48 (defvar vm-folder-directory)
  49
  50 ;; Install the link type
  51 (org-add-link-type "vm" 'org-vm-open)
  52 (add-hook 'org-store-link-functions 'org-vm-store-link)
  53
  54 ;; Implementation
  55 (defun org-vm-store-link ()
  56   "Store a link to a VM folder or message."
  57   (when (or (eq major-mode 'vm-summary-mode)
  58             (eq major-mode 'vm-presentation-mode))
  59     (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
  60     (vm-follow-summary-cursor)
  61     (save-excursion
  62       (vm-select-folder-buffer)
  63       (let* ((message (car vm-message-pointer))
  64              (folder buffer-file-name)
  65              (subject (vm-su-subject message))
  66              (to (vm-get-header-contents message "To"))
  67              (from (vm-get-header-contents message "From"))
  68              (message-id (vm-su-message-id message))
  69              desc link)
  70         (org-store-link-props :type "vm" :from from :to to :subject subject
  71                               :message-id message-id)
  72         (setq message-id (org-remove-angle-brackets message-id))
  73         (setq folder (abbreviate-file-name folder))
  74         (if (and vm-folder-directory
  75                  (string-match (concat "^" (regexp-quote vm-folder-directory))
  76                                folder))
  77             (setq folder (replace-match "" t t folder)))
  78         (setq desc (org-email-link-description))
  79         (setq link (org-make-link "vm:" folder "#" message-id))
  80         (org-add-link-props :link link :description desc)
  81         link))))
  82
  83 (defun org-vm-open (path)
  84   "Follow a VM message link specified by PATH."
  85   (let (folder article)
  86     (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
  87         (error "Error in VM link"))
  88     (setq folder (match-string 1 path)
  89           article (match-string 3 path))
  90     ;; The prefix argument will be interpreted as read-only
  91     (org-vm-follow-link folder article current-prefix-arg)))
  92
  93 (defun org-vm-follow-link (&optional folder article readonly)
  94   "Follow a VM link to FOLDER and ARTICLE."
  95   (require 'vm)
  96   (setq article (org-add-angle-brackets article))
  97   (if (string-match "^//\\([a-zA-Z]+@\\)?\\([^:]+\\):\\(.*\\)" folder)
  98       ;; ange-ftp or efs or tramp access
  99       (let ((user (or (match-string 1 folder) (user-login-name)))
 100             (host (match-string 2 folder))
 101             (file (match-string 3 folder)))
 102         (cond
 103          ((featurep 'tramp)
 104           ;; use tramp to access the file
 105           (if (featurep 'xemacs)
 106               (setq folder (format "[%s@%s]%s" user host file))
 107             (setq folder (format "/%s@%s:%s" user host file))))
 108          (t
 109           ;; use ange-ftp or efs
 110           (require (if (featurep 'xemacs) 'efs 'ange-ftp))
 111           (setq folder (format "/%s@%s:%s" user host file))))))
 112   (when folder
 113     (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
 114     (sit-for 0.1)
 115     (when article
 116       (require 'vm-search)
 117       (vm-select-folder-buffer)
 118       (widen)
 119       (let ((case-fold-search t))
 120         (goto-char (point-min))
 121         (if (not (re-search-forward
 122                   (concat "^" "message-id: *" (regexp-quote article))))
 123             (error "Could not find the specified message in this folder"))
 124         (vm-isearch-update)
 125         (vm-isearch-narrow)
 126         (vm-preview-current-message)
 127         (vm-summarize)))))
 128
 129 (provide 'org-vm)
 130
 131 ;; arch-tag: cbc3047b-935e-4d2a-96e7-c5b0117aaa6d
 132
 133 ;;; org-vm.el ends here