lisp/org-gnus.el

   1 ;;; org-gnus.el --- Support for links to Gnus groups and messages from within Org-mode
   2
   3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
   4 ;;   Free Software Foundation, Inc.
   5
   6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
   7 ;;         Tassilo Horn <tassilo at member dot fsf dot org>
   8 ;; Keywords: outlines, hypermedia, calendar, wp
   9 ;; Homepage: http://orgmode.org
  10 ;; Version: 6.30e
  11 ;;
  12 ;; This file is part of GNU Emacs.
  13 ;;
  14 ;; GNU Emacs is free software: you can redistribute it and/or modify
  15 ;; it under the terms of the GNU General Public License as published by
  16 ;; the Free Software Foundation, either version 3 of the License, or
  17 ;; (at your option) any later version.
  18
  19 ;; GNU Emacs is distributed in the hope that it will be useful,
  20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 ;; GNU General Public License for more details.
  23
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  27 ;;
  28 ;;; Commentary:
  29
  30 ;; This file implements links to Gnus groups and messages from within Org-mode.
  31 ;; Org-mode loads this module by default - if this is not what you want,
  32 ;; configure the variable `org-modules'.
  33
  34 ;;; Code:
  35
  36 (require 'org)
  37 (eval-when-compile (require 'gnus-sum))
  38
  39 ;; Customization variables
  40
  41 (when (fboundp 'defvaralias)
  42   (defvaralias 'org-usenet-links-prefer-google 'org-gnus-prefer-web-links))
  43
  44 (defcustom org-gnus-prefer-web-links nil
  45   "Non-nil means, `org-store-link' will create web links to Google groups.
  46 When nil, Gnus will be used for such links.
  47 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  48 negates this setting for the duration of the command."
  49   :group 'org-link-store
  50   :type 'boolean)
  51
  52 ;; Declare external functions and variables
  53 (declare-function message-fetch-field "message" (header &optional not-all))
  54 (declare-function message-narrow-to-head-1 "message" nil)
  55
  56 (defvar gnus-other-frame-object)
  57 (defvar gnus-group-name)
  58 (defvar gnus-article-current)
  59
  60 ;; Install the link type
  61 (org-add-link-type "gnus" 'org-gnus-open)
  62 (add-hook 'org-store-link-functions 'org-gnus-store-link)
  63
  64 ;; Implementation
  65
  66 (defun org-gnus-group-link (group)
  67   "Create a link to the Gnus group GROUP.
  68 If GROUP is a newsgroup and `org-gnus-prefer-web-links' is
  69 non-nil, create a link to groups.google.com or gmane.org.
  70 Otherwise create a link to the group inside Gnus.
  71
  72 If `org-store-link' was called with a prefix arg the meaning of
  73 `org-gnus-prefer-web-links' is reversed."
  74   (let ((unprefixed-group (replace-regexp-in-string "^[^:]+:" "" group)))
  75     (if (and (string-match "^nntp" group) ;; Only for nntp groups
  76              (org-xor current-prefix-arg
  77                       org-gnus-prefer-web-links))
  78         (org-make-link (if (string-match "gmane" unprefixed-group)
  79                            "http://news.gmane.org/"
  80                          "http://groups.google.com/group/")
  81                        unprefixed-group)
  82       (org-make-link "gnus:" group))))
  83
  84 (defun org-gnus-article-link (group newsgroups message-id x-no-archive)
  85   "Create a link to a Gnus article.
  86 The article is specified by its MESSAGE-ID.  Additional
  87 parameters are the Gnus GROUP, the NEWSGROUPS the article was
  88 posted to and the X-NO-ARCHIVE header value of that article.
  89
  90 If GROUP is a newsgroup and `org-gnus-prefer-web-links' is
  91 non-nil, create a link to groups.google.com or gmane.org.
  92 Otherwise create a link to the article inside Gnus.
  93
  94 If `org-store-link' was called with a prefix arg the meaning of
  95 `org-gnus-prefer-web-links' is reversed."
  96   (if (and (org-xor current-prefix-arg org-gnus-prefer-web-links)
  97            newsgroups     ;; Make web links only for nntp groups
  98            (not x-no-archive)) ;; and if X-No-Archive isn't set.
  99       (format (if (string-match "gmane\\." newsgroups)
 100                   "http://mid.gmane.org/%s"
 101                 "http://groups.google.com/groups/search?as_umsgid=%s")
 102               (org-fixup-message-id-for-http message-id))
 103     (org-make-link "gnus:" group "#" message-id)))
 104
 105 (defun org-gnus-store-link ()
 106   "Store a link to a Gnus folder or message."
 107   (cond
 108    ((eq major-mode 'gnus-group-mode)
 109     (let* ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
 110                          (gnus-group-group-name))         ; version
 111                         ((fboundp 'gnus-group-name)
 112                          (gnus-group-name))
 113                         (t "???")))
 114            desc link)
 115       (when group
 116         (org-store-link-props :type "gnus" :group group)
 117         (setq desc (org-gnus-group-link group)
 118               link desc)
 119         (org-add-link-props :link link :description desc)
 120         link)))
 121
 122    ((memq major-mode '(gnus-summary-mode gnus-article-mode))
 123     (let* ((group gnus-newsgroup-name)
 124            (header (with-current-buffer gnus-summary-buffer
 125                      (gnus-summary-article-header)))
 126            (from (mail-header-from header))
 127            (message-id (org-remove-angle-brackets (mail-header-id header)))
 128            (date (mail-header-date header))
 129            (subject (mail-header-subject header))
 130            (to (cdr (assq 'To (mail-header-extra header))))
 131            newsgroups x-no-archive desc link)
 132       ;; Fetching an article is an expensive operation; newsgroup and
 133       ;; x-no-archive are only needed for web links.
 134       (when (org-xor current-prefix-arg org-gnus-prefer-web-links)
 135         ;; Make sure the original article buffer is up-to-date
 136         (save-window-excursion (gnus-summary-select-article))
 137         (setq to (or to (gnus-fetch-original-field "To"))
 138               newsgroups (gnus-fetch-original-field "Newsgroups")
 139               x-no-archive (gnus-fetch-original-field "x-no-archive")))
 140       (org-store-link-props :type "gnus" :from from :subject subject
 141                             :message-id message-id :group group :to to)
 142       (setq desc (org-email-link-description)
 143             link (org-gnus-article-link
 144                   group newsgroups message-id x-no-archive))
 145       (org-add-link-props :link link :description desc)
 146       link))))
 147
 148 (defun org-gnus-open (path)
 149   "Follow the Gnus message or folder link specified by PATH."
 150   (let (group article)
 151     (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
 152         (error "Error in Gnus link"))
 153     (setq group (match-string 1 path)
 154           article (match-string 3 path))
 155     (when group
 156       (setq group (org-substring-no-properties group)))
 157     (when article
 158       (setq article (org-substring-no-properties article)))
 159     (org-gnus-follow-link group article)))
 160
 161 (defun org-gnus-follow-link (&optional group article)
 162   "Follow a Gnus link to GROUP and ARTICLE."
 163   (require 'gnus)
 164   (funcall (cdr (assq 'gnus org-link-frame-setup)))
 165   (if gnus-other-frame-object (select-frame gnus-other-frame-object))
 166   (when group
 167     (setq group (org-substring-no-properties group)))
 168   (when article
 169     (setq article (org-substring-no-properties article)))
 170   (cond ((and group article)
 171          (gnus-activate-group group t)
 172          (condition-case nil
 173              (let ((articles 1)
 174                    group-opened)
 175                (while (and (not group-opened)
 176                            ;; stop on integer overflows
 177                            (> articles 0))
 178                  (setq group-opened (gnus-group-read-group articles nil group)
 179                        articles (if (< articles 16)
 180                                     (1+ articles)
 181                                   (* articles 2))))
 182                (if group-opened
 183                    (gnus-summary-goto-article article nil t)
 184                  (message "Couldn't follow gnus link.  %s"
 185                           "The summary couldn't be opened.")))
 186            (quit (message "Couldn't follow gnus link.  %s"
 187                           "The linked group is empty."))))
 188         (group (gnus-group-jump-to-group group))))
 189
 190 (defun org-gnus-no-new-news ()
 191   "Like `M-x gnus' but doesn't check for new news."
 192   (if (not (gnus-alive-p)) (gnus)))
 193
 194 (provide 'org-gnus)
 195
 196 ;; arch-tag: 512e0840-58fa-45b3-b456-71e10fa2376d
 197
 198 ;;; org-gnus.el ends here