git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus-registry.el

   1 ;;; gnus-registry.el --- article registry for Gnus
   2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
   3 ;;        Free Software Foundation, Inc.
   4
   5 ;; Author: Ted Zlatanov <tzz@lifelogs.com>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs 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 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (eval-when-compile (require 'cl))
  30
  31 (require 'gnus)
  32 (require 'gnus-int)
  33 (require 'gnus-sum)
  34 (require 'nnmail)
  35
  36 (defgroup gnus-registry nil
  37   "The Gnus registry."
  38   :group 'gnus)
  39
  40 (defvar gnus-registry-hashtb nil
  41   "*The article registry by Message ID.")
  42
  43 (defvar gnus-registry-headers-hashtb nil
  44   "*The article header registry by Message ID.")
  45
  46 (defcustom gnus-registry-unfollowed-groups '("delayed" "drafts" "queue")
  47   "List of groups that gnus-registry-split-fancy-with-parent won't follow.
  48 The group names are matched, they don't have to be fully qualified."
  49   :group 'gnus-registry
  50   :type '(repeat string))
  51
  52 ;; Function(s) missing in Emacs 20
  53 (when (memq nil (mapcar 'fboundp '(puthash)))
  54   (require 'cl)
  55   (unless (fboundp 'puthash)
  56     ;; alias puthash is missing from Emacs 20 cl-extra.el
  57     (defalias 'puthash 'cl-puthash)))
  58
  59 (defun gnus-registry-translate-to-alist ()
  60   (setq gnus-registry-alist (hashtable-to-alist gnus-registry-hashtb))
  61   (setq gnus-registry-headers-alist (hashtable-to-alist
  62                                      gnus-registry-headers-hashtb)))
  63
  64 (defun gnus-registry-translate-from-alist ()
  65   (setq gnus-registry-hashtb (alist-to-hashtable gnus-registry-alist))
  66   (setq gnus-registry-headers-hashtb (alist-to-hashtable
  67                                       gnus-registry-headers-alist)))
  68
  69 (defun alist-to-hashtable (alist)
  70   "Build a hashtable from the values in ALIST."
  71   (let ((ht (make-hash-table
  72              :size 4096
  73              :test 'equal)))
  74     (mapc
  75      (lambda (kv-pair)
  76        (puthash (car kv-pair) (cdr kv-pair) ht))
  77      alist)
  78      ht))
  79
  80 (defun hashtable-to-alist (hash)
  81   "Build an alist from the values in HASH."
  82   (let ((list nil))
  83     (maphash
  84      (lambda (key value)
  85        (setq list (cons (cons key value) list)))
  86      hash)
  87     list))
  88
  89 (defun gnus-register-action (action data-header from &optional to method)
  90   (let* ((id (mail-header-id data-header))
  91         (from (gnus-group-guess-full-name from))
  92         (to (if to (gnus-group-guess-full-name to) nil))
  93         (to-name (if to to "the Bit Bucket")))
  94     (gnus-message 5 "Registry: article %s %s from %s to %s"
  95                   id
  96                   (if method "respooling" "going")
  97                   from
  98                   to)
  99     (unless (gethash id gnus-registry-headers-hashtb)
 100       (puthash id (list data-header) gnus-registry-headers-hashtb))
 101     (puthash id (cons (list action from to)
 102                       (gethash id gnus-registry-hashtb))
 103              gnus-registry-hashtb)))
 104
 105 (defun gnus-register-spool-action (id group)
 106   ;; do not process the draft IDs
 107 ;  (unless (string-match "totally-fudged-out-message-id" id)
 108     (let ((group (gnus-group-guess-full-name group)))
 109     (when (string-match "\r$" id)
 110       (setq id (substring id 0 -1)))
 111     (gnus-message 5 "Registry: article %s spooled to %s"
 112                   id
 113                   group)
 114     (puthash id (cons (list 'spool nil group)
 115                       (gethash id gnus-registry-hashtb))
 116              gnus-registry-hashtb)))
 117 ;)
 118
 119 ;; Function for nn{mail|imap}-split-fancy: look up all references in
 120 ;; the cache and if a match is found, return that group.
 121 (defun gnus-registry-split-fancy-with-parent ()
 122   "Split this message into the same group as its parent.  The parent
 123 is obtained from the registry.  This function can be used as an entry
 124 in `nnmail-split-fancy' or `nnimap-split-fancy', for example like
 125 this: (: gnus-registry-split-fancy-with-parent)
 126
 127 For a message to be split, it looks for the parent message in the
 128 References or In-Reply-To header and then looks in the registry to
 129 see which group that message was put in.  This group is returned.
 130
 131 See the Info node `(gnus)Fancy Mail Splitting' for more details."
 132   (let ((refstr (or (message-fetch-field "references")
 133                     (message-fetch-field "in-reply-to")))
 134         (references nil)
 135         (res nil))
 136     (when refstr
 137       (setq references (nreverse (gnus-split-references refstr)))
 138       (mapcar (lambda (x)
 139                 (setq res (or (gnus-registry-fetch-group x) res))
 140                 (when (or (gnus-registry-grep-in-list
 141                            res
 142                            gnus-registry-unfollowed-groups)
 143                           (gnus-registry-grep-in-list
 144                            res
 145                            nnmail-split-fancy-with-parent-ignore-groups))
 146                   (setq res nil)))
 147               references)
 148       res)))
 149
 150 (defun gnus-registry-grep-in-list (word list)
 151   (memq nil
 152         (mapcar 'not
 153          (mapcar
 154           (lambda (x)
 155             (string-match x word))
 156           list))))
 157
 158
 159 (defun gnus-registry-fetch-group (id)
 160   "Get the group of a message, based on the message ID.
 161 Returns the first place where the trail finds a spool action."
 162   (let ((trail (gethash id gnus-registry-hashtb)))
 163     (dolist (crumb trail)
 164       (let ((action (nth 0 crumb))
 165             (from (nth 1 crumb))
 166             (to (nth 2 crumb)))
 167         (when (eq action 'spool)
 168           (return to))))))
 169
 170 (defun gnus-registry-clear ()
 171   "Clear the Gnus registry."
 172   (interactive)
 173   (setq gnus-registry-alist nil
 174         gnus-registry-headers-alist nil)
 175   (gnus-registry-translate-from-alist))
 176
 177 ; also does copy, respool, and crosspost
 178 (add-hook 'gnus-summary-article-move-hook 'gnus-register-action)
 179 (add-hook 'gnus-summary-article-delete-hook 'gnus-register-action)
 180 (add-hook 'gnus-summary-article-expire-hook 'gnus-register-action)
 181 (add-hook 'nnmail-spool-hook 'gnus-register-spool-action)
 182
 183 (add-hook 'gnus-save-newsrc-hook 'gnus-registry-translate-to-alist)
 184 (add-hook 'gnus-read-newsrc-el-hook 'gnus-registry-translate-from-alist)
 185
 186 ;; TODO: a lot of things
 187
 188 (provide 'gnus-registry)
 189
 190 ;;; gnus-registry.el ends here