1 ;;; gnus-registry.el --- article registry for Gnus
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
3 ;; Free Software Foundation, Inc.
5 ;; Author: Ted Zlatanov <tzz@lifelogs.com>
8 ;; This file is part of GNU Emacs.
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)
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.
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.
29 (eval-when-compile (require 'cl))
36 (defgroup gnus-registry nil
40 (defvar gnus-registry-hashtb nil
41 "*The article registry by Message ID.")
43 (defvar gnus-registry-headers-hashtb nil
44 "*The article header registry by Message ID. Unused for now.")
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."
50 :type '(repeat string))
52 (defcustom gnus-registry-unregistered-group-regex "^nntp"
53 "Group name regex that gnus-registry-register-message-ids won't process."
57 ;; Function(s) missing in Emacs 20
58 (when (memq nil (mapcar 'fboundp '(puthash)))
60 (unless (fboundp 'puthash)
61 ;; alias puthash is missing from Emacs 20 cl-extra.el
62 (defalias 'puthash 'cl-puthash)))
64 (defun gnus-registry-translate-to-alist ()
65 (setq gnus-registry-alist (hashtable-to-alist gnus-registry-hashtb)))
67 (defun gnus-registry-translate-from-alist ()
68 (setq gnus-registry-hashtb (alist-to-hashtable gnus-registry-alist)))
70 (defun alist-to-hashtable (alist)
71 "Build a hashtable from the values in ALIST."
72 (let ((ht (make-hash-table
77 (puthash (car kv-pair) (cdr kv-pair) ht))
81 (defun hashtable-to-alist (hash)
82 "Build an alist from the values in HASH."
86 (setq list (cons (cons key value) list)))
90 (defun gnus-register-action (action data-header from &optional to method)
91 (let* ((id (mail-header-id data-header))
92 (from (gnus-group-guess-full-name from))
93 (to (if to (gnus-group-guess-full-name to) nil))
94 (to-name (if to to "the Bit Bucket"))
95 (old-entry (gethash id gnus-registry-hashtb)))
96 (gnus-message 5 "Registry: article %s %s from %s to %s"
98 (if method "respooling" "going")
102 ;; All except copy will need a delete
103 (gnus-registry-delete-group id from)
105 (when (equal 'copy action)
106 (gnus-registry-add-group id from)) ; undo the delete
108 (gnus-registry-add-group id to)))
110 (defun gnus-register-spool-action (id group)
111 ;; do not process the draft IDs
112 ; (unless (string-match "totally-fudged-out-message-id" id)
113 ; (let ((group (gnus-group-guess-full-name group)))
114 (when (string-match "\r$" id)
115 (setq id (substring id 0 -1)))
116 (gnus-message 5 "Registry: article %s spooled to %s"
119 (gnus-registry-add-group id group))
122 ;; Function for nn{mail|imap}-split-fancy: look up all references in
123 ;; the cache and if a match is found, return that group.
124 (defun gnus-registry-split-fancy-with-parent ()
125 "Split this message into the same group as its parent. The parent
126 is obtained from the registry. This function can be used as an entry
127 in `nnmail-split-fancy' or `nnimap-split-fancy', for example like
128 this: (: gnus-registry-split-fancy-with-parent)
130 For a message to be split, it looks for the parent message in the
131 References or In-Reply-To header and then looks in the registry to
132 see which group that message was put in. This group is returned.
134 See the Info node `(gnus)Fancy Mail Splitting' for more details."
135 (let ((refstr (or (message-fetch-field "references")
136 (message-fetch-field "in-reply-to")))
140 (setq references (nreverse (gnus-split-references refstr)))
142 (setq res (or (gnus-registry-fetch-group x) res))
143 (when (or (gnus-registry-grep-in-list
145 gnus-registry-unfollowed-groups)
146 (gnus-registry-grep-in-list
148 nnmail-split-fancy-with-parent-ignore-groups))
153 "gnus-registry-split-fancy-with-parent traced %s to group %s"
154 refstr (if res res "nil"))
157 (defun gnus-registry-register-message-ids ()
158 "Register the Message-ID of every article in the group"
159 (unless (and gnus-registry-unregistered-group-regex
160 (string-match gnus-registry-unregistered-group-regex gnus-newsgroup-name))
161 (dolist (article gnus-newsgroup-articles)
162 (let ((id (gnus-registry-fetch-message-id-fast article)))
163 (unless (gnus-registry-fetch-group id)
164 (gnus-message 9 "Registry: Registering article %d with group %s"
165 article gnus-newsgroup-name)
166 (gnus-registry-add-group (gnus-registry-fetch-message-id-fast article)
167 gnus-newsgroup-name))))))
169 (defun gnus-registry-fetch-message-id-fast (article)
170 "Fetch the Message-ID quickly, using the internal gnus-data-list function"
171 (if (and (numberp article)
172 (assoc article (gnus-data-list nil)))
173 (mail-header-id (gnus-data-header (assoc article (gnus-data-list nil))))
176 (defun gnus-registry-grep-in-list (word list)
182 (string-match x word))
185 (defun gnus-registry-fetch-group (id)
186 "Get the group of a message, based on the message ID.
187 Returns the first place where the trail finds a spool action."
189 (let ((trail (gethash id gnus-registry-hashtb)))
194 (defun gnus-registry-delete-group (id group)
195 "Get the group of a message, based on the message ID.
196 Returns the first place where the trail finds a spool action."
199 (let ((trail (gethash id gnus-registry-hashtb))
200 (group (gnus-group-short-name group)))
201 (puthash id (if trail
204 gnus-registry-hashtb))
205 ;; now, clear the entry if it's empty
206 (unless (gethash id gnus-registry-hashtb)
207 (remhash id gnus-registry-hashtb)))))
209 (defun gnus-registry-add-group (id group)
210 "Get the group of a message, based on the message ID.
211 Returns the first place where the trail finds a spool action."
212 ;; make sure there are no duplicate entries
215 (let ((group (gnus-group-short-name group)))
216 (gnus-registry-delete-group id group)
217 (let ((trail (gethash id gnus-registry-hashtb)))
218 (puthash id (if trail
221 gnus-registry-hashtb))))))
223 (defun gnus-registry-clear ()
224 "Clear the Gnus registry."
226 (setq gnus-registry-alist nil
227 gnus-registry-headers-alist nil)
228 (gnus-registry-translate-from-alist))
230 ; also does copy, respool, and crosspost
231 (add-hook 'gnus-summary-article-move-hook 'gnus-register-action)
232 (add-hook 'gnus-summary-article-delete-hook 'gnus-register-action)
233 (add-hook 'gnus-summary-article-expire-hook 'gnus-register-action)
234 (add-hook 'nnmail-spool-hook 'gnus-register-spool-action)
236 (add-hook 'gnus-save-newsrc-hook 'gnus-registry-translate-to-alist)
237 (add-hook 'gnus-read-newsrc-el-hook 'gnus-registry-translate-from-alist)
239 (add-hook 'gnus-summary-prepare-hook 'gnus-registry-register-message-ids)
241 ;; TODO: a lot of things
243 (provide 'gnus-registry)
245 ;;; gnus-registry.el ends here