Synopsis: Migrate allout encryption provisions from pgg library, which is
[bpt/emacs.git] / lisp / org / org-gnus.el
index f41425e..fccd3e9 100644 (file)
@@ -1,13 +1,13 @@
 ;;; org-gnus.el --- Support for links to Gnus groups and messages from within Org-mode
 
-;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
+;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
 ;;   Free Software Foundation, Inc.
 
 ;; Author: Carsten Dominik <carsten at orgmode dot org>
 ;;         Tassilo Horn <tassilo at member dot fsf dot org>
 ;; Keywords: outlines, hypermedia, calendar, wp
 ;; Homepage: http://orgmode.org
-;; Version: 6.33c
+;; Version: 7.4
 ;;
 ;; This file is part of GNU Emacs.
 ;;
 ;; Declare external functions and variables
 (declare-function message-fetch-field "message" (header &optional not-all))
 (declare-function message-narrow-to-head-1 "message" nil)
+(declare-function nnimap-group-overview-filename "nnimap" (group server))
 ;; The following line suppresses a compiler warning stemming from gnus-sum.el
 (declare-function gnus-summary-last-subject "gnus-sum" nil)
-
 ;; Customization variables
 
 (when (fboundp 'defvaralias)
   (defvaralias 'org-usenet-links-prefer-google 'org-gnus-prefer-web-links))
 
 (defcustom org-gnus-prefer-web-links nil
-  "Non-nil means, `org-store-link' will create web links to Google groups.
+  "If non-nil, `org-store-link' creates web links to Google groups or Gmane.
 When nil, Gnus will be used for such links.
 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
 negates this setting for the duration of the command."
   :group 'org-link-store
   :type 'boolean)
 
+(defcustom org-gnus-nnimap-query-article-no-from-file nil
+  "If non-nil, `org-gnus-follow-link' will try to translate
+Message-Ids to article numbers by querying the .overview file.
+Normally, this translation is done by querying the IMAP server,
+which is usually very fast.  Unfortunately, some (maybe badly
+configured) IMAP servers don't support this operation quickly.
+So if following a link to a Gnus article takes ages, try setting
+this variable to `t'."
+  :group 'org-link-store
+  :type 'boolean)
+
 
 ;; Install the link type
 (org-add-link-type "gnus" 'org-gnus-open)
@@ -62,6 +73,22 @@ negates this setting for the duration of the command."
 
 ;; Implementation
 
+(defun org-gnus-nnimap-cached-article-number (group server message-id)
+  "Return cached article number (uid) of message in GROUP on SERVER.
+MESSAGE-ID is the message-id header field that identifies the
+message.  If the uid is not cached, return nil."
+  (with-temp-buffer
+    (let ((nov (nnimap-group-overview-filename group server)))
+      (when (file-exists-p nov)
+       (mm-insert-file-contents nov)
+       (set-buffer-modified-p nil)
+       (goto-char (point-min))
+       (catch 'found
+         (while (search-forward message-id nil t)
+           (let ((hdr (split-string (thing-at-point 'line) "\t")))
+             (if (string= (nth 4 hdr) message-id)
+                 (throw 'found (nth 0 hdr))))))))))
+
 (defun org-gnus-group-link (group)
   "Create a link to the Gnus group GROUP.
 If GROUP is a newsgroup and `org-gnus-prefer-web-links' is
@@ -120,30 +147,52 @@ If `org-store-link' was called with a prefix arg the meaning of
 
    ((memq major-mode '(gnus-summary-mode gnus-article-mode))
     (let* ((group gnus-newsgroup-name)
-          (header (with-current-buffer gnus-summary-buffer
+          (header (with-current-buffer gnus-summary-buffer
                     (gnus-summary-article-header)))
           (from (mail-header-from header))
           (message-id (org-remove-angle-brackets (mail-header-id header)))
           (date (mail-header-date header))
-          (subject (mail-header-subject header))
-           (to (cdr (assq 'To (mail-header-extra header))))
-           newsgroups x-no-archive desc link)
+          (date-ts (and date (format-time-string
+                              (org-time-stamp-format t) (date-to-time date))))
+          (date-ts-ia (and date (format-time-string
+                                 (org-time-stamp-format t t)
+                                 (date-to-time date))))
+          (subject (copy-sequence (mail-header-subject header)))
+          (to (cdr (assq 'To (mail-header-extra header))))
+          newsgroups x-no-archive desc link)
+      ;; Remove text properties of subject string to avoid Emacs bug
+      ;; #3506
+      (set-text-properties 0 (length subject) nil subject)
+
       ;; Fetching an article is an expensive operation; newsgroup and
       ;; x-no-archive are only needed for web links.
       (when (org-xor current-prefix-arg org-gnus-prefer-web-links)
-        ;; Make sure the original article buffer is up-to-date
-        (save-window-excursion (gnus-summary-select-article))
-        (setq to (or to (gnus-fetch-original-field "To"))
-              newsgroups (gnus-fetch-original-field "Newsgroups")
-              x-no-archive (gnus-fetch-original-field "x-no-archive")))
-      (org-store-link-props :type "gnus" :from from :subject subject
+       ;; Make sure the original article buffer is up-to-date
+       (save-window-excursion (gnus-summary-select-article))
+       (setq to (or to (gnus-fetch-original-field "To"))
+             newsgroups (gnus-fetch-original-field "Newsgroups")
+             x-no-archive (gnus-fetch-original-field "x-no-archive")))
+      (org-store-link-props :type "gnus" :from from :subject subject 
                            :message-id message-id :group group :to to)
+      (when date
+       (org-add-link-props :date date :date-timestamp date-ts
+                           :date-timestamp-inactive date-ts-ia))
       (setq desc (org-email-link-description)
            link (org-gnus-article-link
                  group newsgroups message-id x-no-archive))
       (org-add-link-props :link link :description desc)
       link))))
 
+(defun org-gnus-open-nntp (path)
+  "Follow the nntp: link specified by PATH."
+  (let* ((spec (split-string path "/"))
+        (server (split-string (nth 2 spec) "@"))
+        (group (nth 3 spec))
+        (article (nth 4 spec)))
+    (org-gnus-follow-link
+     (format "nntp+%s:%s" (or (cdr server) (car server)) group)
+     article)))
+
 (defun org-gnus-open (path)
   "Follow the Gnus message or folder link specified by PATH."
   (let (group article)
@@ -169,19 +218,36 @@ If `org-store-link' was called with a prefix arg the meaning of
   (cond ((and group article)
         (gnus-activate-group group t)
         (condition-case nil
-            (let ((articles 1)
-                  group-opened)
-              (while (and (not group-opened)
-                          ;; stop on integer overflows
-                          (> articles 0))
-                (setq group-opened (gnus-group-read-group articles nil group)
-                      articles (if (< articles 16)
-                                   (1+ articles)
-                                 (* articles 2))))
-              (if group-opened
-                  (gnus-summary-goto-article article nil t)
-                (message "Couldn't follow gnus link.  %s"
-                         "The summary couldn't be opened.")))
+            (let* ((method (gnus-find-method-for-group group))
+                   (backend (car method))
+                   (server (cadr method)))
+              (cond
+               ((eq backend 'nndoc)
+                (if (gnus-group-read-group t nil group)
+                    (gnus-summary-goto-article article nil t)
+                  (message "Couldn't follow gnus link.  %s"
+                           "The summary couldn't be opened.")))
+               (t
+                (let ((articles 1)
+                      group-opened)
+                  (when (and (eq backend 'nnimap)
+                             org-gnus-nnimap-query-article-no-from-file)
+                    (setq article
+                          (or (org-gnus-nnimap-cached-article-number
+                               (nth 1 (split-string group ":"))
+                               server (concat "<" article ">")) article)))
+                  (while (and (not group-opened)
+                              ;; stop on integer overflows
+                              (> articles 0))
+                    (setq group-opened (gnus-group-read-group
+                                        articles nil group)
+                          articles (if (< articles 16)
+                                       (1+ articles)
+                                     (* articles 2))))
+                  (if group-opened
+                      (gnus-summary-goto-article article nil t)
+                    (message "Couldn't follow gnus link.  %s"
+                             "The summary couldn't be opened."))))))
           (quit (message "Couldn't follow gnus link.  %s"
                          "The linked group is empty."))))
        (group (gnus-group-jump-to-group group))))