1 ;;; gnus-registry.el --- article registry for Gnus
3 ;; Copyright (C) 2002-2011 Free Software Foundation, Inc.
5 ;; Author: Ted Zlatanov <tzz@lifelogs.com>
6 ;; Keywords: news registry
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 3 of the License, or
13 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
25 ;; This is the gnus-registry.el package, which works with all
26 ;; Gnus backends, not just nnmail. The major issue is that it
27 ;; doesn't go across backends, so for instance if an article is in
28 ;; nnml:sys and you see a reference to it in nnimap splitting, the
29 ;; article will end up in nnimap:sys
31 ;; gnus-registry.el intercepts article respooling, moving, deleting,
32 ;; and copying for all backends. If it doesn't work correctly for
33 ;; you, submit a bug report and I'll be glad to fix it. It needs
34 ;; documentation in the manual (also on my to-do list).
36 ;; Put this in your startup file (~/.gnus.el for instance) or use Customize:
38 ;; (setq gnus-registry-max-entries 2500
39 ;; gnus-registry-track-extra '(sender subject recipient))
41 ;; (gnus-registry-initialize)
43 ;; Then use this in your fancy-split:
45 ;; (: gnus-registry-split-fancy-with-parent)
47 ;; You should also consider using the nnregistry backend to look up
48 ;; articles. See the Gnus manual for more information.
52 ;; - get the correct group on spool actions
54 ;; - articles that are spooled to a different backend should be moved
59 (eval-when-compile (require 'cl))
62 (when (null (ignore-errors (require 'ert)))
63 (defmacro* ert-deftest (name () &body docstring-keys-and-body))))
76 (defvar gnus-adaptive-word-syntax-table)
78 (defvar gnus-registry-dirty t
79 "Boolean set to t when the registry is modified")
81 (defgroup gnus-registry nil
86 (defvar gnus-registry-marks
89 :image "summary_important")
92 :image "summary_work")
95 :image "summary_personal")
98 :image "summary_todo")
101 :image "summary_later"))
103 "List of registry marks and their options.
105 `gnus-registry-mark-article' will offer symbols from this list
108 Each entry must have a character to be useful for summary mode
109 line display and for keyboard shortcuts.
111 Each entry must have an image string to be useful for visual
114 (defcustom gnus-registry-default-mark 'To-Do
115 "The default mark. Should be a valid key for `gnus-registry-marks'."
116 :group 'gnus-registry
119 (defcustom gnus-registry-unfollowed-addresses
120 (list (regexp-quote user-mail-address))
121 "List of addresses that gnus-registry-split-fancy-with-parent won't trace.
122 The addresses are matched, they don't have to be fully qualified.
123 In the messages, these addresses can be the sender or the
125 :group 'gnus-registry
126 :type '(repeat regexp))
128 (defcustom gnus-registry-unfollowed-groups
129 '("delayed$" "drafts$" "queue$" "INBOX$" "^nnmairix:" "archive")
130 "List of groups that gnus-registry-split-fancy-with-parent won't return.
131 The group names are matched, they don't have to be fully
132 qualified. This parameter tells the Gnus registry 'never split a
133 message into a group that matches one of these, regardless of
136 nnmairix groups are specifically excluded because they are ephemeral."
137 :group 'gnus-registry
138 :type '(repeat regexp))
140 (defcustom gnus-registry-install 'ask
141 "Whether the registry should be installed."
142 :group 'gnus-registry
143 :type '(choice (const :tag "Never Install" nil)
144 (const :tag "Always Install" t)
145 (const :tag "Ask Me" ask)))
147 (defvar gnus-summary-misc-menu) ;; Avoid byte compiler warning.
149 (defvar gnus-registry-misc-menus nil) ; ugly way to keep the menus
151 (make-obsolete-variable 'gnus-registry-clean-empty nil "23.4")
152 (make-obsolete-variable 'gnus-registry-use-long-group-names nil "23.4")
153 (make-obsolete-variable 'gnus-registry-max-track-groups nil "23.4")
154 (make-obsolete-variable 'gnus-registry-entry-caching nil "23.4")
155 (make-obsolete-variable 'gnus-registry-trim-articles-without-groups nil "23.4")
157 (defcustom gnus-registry-track-extra '(subject sender recipient)
158 "Whether the registry should track extra data about a message.
159 The subject, recipients (To: and Cc:), and Sender (From:) headers
160 are tracked this way by default."
161 :group 'gnus-registry
163 '(set :tag "Tracking choices"
164 (const :tag "Track by subject (Subject: header)" subject)
165 (const :tag "Track by recipient (To: and Cc: headers)" recipient)
166 (const :tag "Track by sender (From: header)" sender)))
168 (defcustom gnus-registry-split-strategy nil
169 "The splitting strategy applied to the keys in `gnus-registry-track-extra'.
171 Given a set of unique found groups G and counts for each element
172 of G, and a key K (typically 'sender or 'subject):
174 When nil, if G has only one element, use it. Otherwise give up.
175 This is the fastest but also least useful strategy.
177 When 'majority, use the majority by count. So if there is a
178 group with the most articles counted by K, use that. Ties are
179 resolved in no particular order, simply the first one found wins.
180 This is the slowest strategy but also the most accurate one.
182 When 'first, the first element of G wins. This is fast and
183 should be OK if your senders and subjects don't \"bleed\" across
185 :group 'gnus-registry
187 '(choice :tag "Splitting strategy"
188 (const :tag "Only use single choices, discard multiple matches" nil)
189 (const :tag "Majority of matches wins" majority)
190 (const :tag "First found wins" first)))
192 (defcustom gnus-registry-minimum-subject-length 5
193 "The minimum length of a subject before it's considered trackable."
194 :group 'gnus-registry
197 (defcustom gnus-registry-extra-entries-precious '(mark)
198 "What extra keys are precious, meaning entries with them won't get pruned.
199 By default, 'mark is included, so articles with marks are
202 Before you save the Gnus registry, it's pruned. Any entries with
203 keys in this list will not be pruned. All other entries go to
205 :group 'gnus-registry
206 :type '(repeat symbol))
208 (defcustom gnus-registry-cache-file
210 (or gnus-dribble-directory gnus-home-directory "~/")
211 ".gnus.registry.eioio")
212 "File where the Gnus registry will be stored."
213 :group 'gnus-registry
216 (defcustom gnus-registry-max-entries nil
217 "Maximum number of entries in the registry, nil for unlimited."
218 :group 'gnus-registry
219 :type '(radio (const :format "Unlimited " nil)
220 (integer :format "Maximum number: %v")))
222 (defcustom gnus-registry-max-pruned-entries nil
223 "Maximum number of pruned entries in the registry, nil for unlimited."
224 :group 'gnus-registry
225 :type '(radio (const :format "Unlimited " nil)
226 (integer :format "Maximum number: %v")))
228 (defun gnus-registry-fixup-registry (db)
230 (let ((old (oref db :tracked)))
232 (append gnus-registry-extra-entries-precious
235 (or gnus-registry-max-entries
236 most-positive-fixnum))
238 (or gnus-registry-max-pruned-entries
239 most-positive-fixnum))
241 (append gnus-registry-track-extra
242 '(mark group keyword)))
243 (when (not (equal old (oref db :tracked)))
244 (gnus-message 4 "Reindexing the Gnus registry (tracked change)")
245 (registry-reindex db))))
248 (defun gnus-registry-make-db (&optional file)
249 (interactive "fGnus registry persistence file: \n")
250 (gnus-registry-fixup-registry
253 :file (or file gnus-registry-cache-file)
254 ;; these parameters are set in `gnus-registry-fixup-registry'
255 :max-hard most-positive-fixnum
256 :max-soft most-positive-fixnum
260 (defvar gnus-registry-db (gnus-registry-make-db)
261 "*The article registry by Message ID. See `registry-db'")
263 ;; top-level registry data management
264 (defun gnus-registry-remake-db (&optional forsure)
265 "Remake the registry database after customization.
266 This is not required after changing `gnus-registry-cache-file'."
267 (interactive (list (y-or-n-p "Remake and CLEAR the Gnus registry? ")))
269 (gnus-message 4 "Remaking the Gnus registry")
270 (setq gnus-registry-db (gnus-registry-make-db))))
272 (defun gnus-registry-read ()
273 "Read the registry cache file."
275 (let ((file gnus-registry-cache-file))
278 (gnus-message 5 "Reading Gnus registry from %s..." file)
279 (setq gnus-registry-db (gnus-registry-fixup-registry
280 (eieio-persistent-read file)))
281 (gnus-message 5 "Reading Gnus registry from %s...done" file))
285 "The Gnus registry could not be loaded from %s, creating a new one"
287 (gnus-registry-remake-db t)))))
289 (defun gnus-registry-save (&optional file db)
290 "Save the registry cache file."
292 (let ((file (or file gnus-registry-cache-file))
293 (db (or db gnus-registry-db)))
294 (gnus-message 5 "Saving Gnus registry (%d entries) to %s..."
295 (registry-size db) file)
297 ;; TODO: call (gnus-string-remove-all-properties v) on all elements?
298 (eieio-persistent-save db file)
299 (gnus-message 5 "Saving Gnus registry (size %d) to %s...done"
300 (registry-size db) file)))
302 ;; article move/copy/spool/delete actions
303 (defun gnus-registry-action (action data-header from &optional to method)
304 (let* ((id (mail-header-id data-header))
305 (subject (mail-header-subject data-header))
306 (recipients (gnus-registry-sort-addresses
307 (or (ignore-errors (mail-header "Cc" data-header)) "")
308 (or (ignore-errors (mail-header "To" data-header)) "")))
309 (sender (nth 0 (gnus-registry-extract-addresses
310 (mail-header-from data-header))))
311 (from (gnus-group-guess-full-name-from-command-method from))
312 (to (if to (gnus-group-guess-full-name-from-command-method to) nil))
313 (to-name (if to to "the Bit Bucket")))
314 (gnus-message 7 "Gnus registry: article %s %s from %s to %s"
315 id (if method "respooling" "going") from to)
317 (gnus-registry-handle-action
319 ;; unless copying, remove the old "from" group
320 (if (not (equal 'copy action)) from nil)
321 to subject sender recipients)))
323 (defun gnus-registry-spool-action (id group &optional subject sender recipients)
324 (let ((to (gnus-group-guess-full-name-from-command-method group))
325 (recipients (or recipients
326 (gnus-registry-sort-addresses
327 (or (message-fetch-field "cc") "")
328 (or (message-fetch-field "to") ""))))
329 (subject (or subject (message-fetch-field "subject")))
330 (sender (or sender (message-fetch-field "from"))))
331 (when (and (stringp id) (string-match "\r$" id))
332 (setq id (substring id 0 -1)))
333 (gnus-message 7 "Gnus registry: article %s spooled to %s"
336 (gnus-registry-handle-action id nil to subject sender recipients)))
338 (defun gnus-registry-handle-action (id from to subject sender
339 &optional recipients)
342 "gnus-registry-handle-action %S" (list id from to subject sender recipients))
343 (let ((db gnus-registry-db)
345 (entry (gnus-registry-get-or-make-entry id))
346 (subject (gnus-string-remove-all-properties
347 (gnus-registry-simplify-subject subject)))
348 (sender (gnus-string-remove-all-properties sender)))
350 ;; this could be done by calling `gnus-registry-set-id-key'
351 ;; several times but it's better to bunch the transactions
354 (registry-delete db (list id) nil)
356 (setq entry (cons (delete from (assoc 'group entry))
357 (assq-delete-all 'group entry))))
359 (dolist (kv `((group ,to)
361 (recipient ,@recipients)
364 (let ((new (or (assq (first kv) entry)
366 (dolist (toadd (cdr kv))
367 (add-to-list 'new toadd t))
368 (setq entry (cons new
369 (assq-delete-all (first kv) entry))))))
370 (gnus-message 10 "Gnus registry: new entry for %s is %S"
373 (registry-insert db id entry)))
375 ;; Function for nn{mail|imap}-split-fancy: look up all references in
376 ;; the cache and if a match is found, return that group.
377 (defun gnus-registry-split-fancy-with-parent ()
378 "Split this message into the same group as its parent. The parent
379 is obtained from the registry. This function can be used as an entry
380 in `nnmail-split-fancy' or `nnimap-split-fancy', for example like
381 this: (: gnus-registry-split-fancy-with-parent)
383 This function tracks ALL backends, unlike
384 `nnmail-split-fancy-with-parent' which tracks only nnmail
387 For a message to be split, it looks for the parent message in the
388 References or In-Reply-To header and then looks in the registry
389 to see which group that message was put in. This group is
390 returned, unless `gnus-registry-follow-group-p' return nil for
393 See the Info node `(gnus)Fancy Mail Splitting' for more details."
394 (let* ((refstr (or (message-fetch-field "references") "")) ; guaranteed
395 (reply-to (message-fetch-field "in-reply-to")) ; may be nil
396 ;; now, if reply-to is valid, append it to the References
398 (concat refstr " " reply-to)
400 (references (and refstr (gnus-extract-references refstr)))
401 ;; these may not be used, but the code is cleaner having them up here
402 (sender (gnus-string-remove-all-properties
403 (message-fetch-field "from")))
404 (recipients (gnus-registry-sort-addresses
405 (or (message-fetch-field "cc") "")
406 (or (message-fetch-field "to") "")))
407 (subject (gnus-string-remove-all-properties
408 (gnus-registry-simplify-subject
409 (message-fetch-field "subject"))))
411 (nnmail-split-fancy-with-parent-ignore-groups
412 (if (listp nnmail-split-fancy-with-parent-ignore-groups)
413 nnmail-split-fancy-with-parent-ignore-groups
414 (list nnmail-split-fancy-with-parent-ignore-groups))))
415 (gnus-registry--split-fancy-with-parent-internal
416 :references references
419 :recipients recipients
421 :log-agent "Gnus registry fancy splitting with parent")))
423 (defun* gnus-registry--split-fancy-with-parent-internal
425 &key references refstr sender subject recipients log-agent
429 "gnus-registry--split-fancy-with-parent-internal %S" spec)
430 (let ((db gnus-registry-db)
432 ;; this is a big chain of statements. it uses
433 ;; gnus-registry-post-process-groups to filter the results after
435 ;; the references string must be valid and parse to valid references
439 "%s is tracing references %s"
441 (dolist (reference (nreverse references))
442 (gnus-message 9 "%s is looking up %s" log-agent reference)
443 (loop for group in (gnus-registry-get-id-key reference 'group)
444 when (gnus-registry-follow-group-p group)
445 do (gnus-message 7 "%s traced %s to %s" log-agent reference group)
446 do (push group found)))
447 ;; filter the found groups and return them
448 ;; the found groups are the full groups
449 (setq found (gnus-registry-post-process-groups
450 "references" refstr found)))
452 ;; else: there were no matches, now try the extra tracking by subject
453 (when (and (null found)
454 (memq 'subject gnus-registry-track-extra)
456 (< gnus-registry-minimum-subject-length (length subject)))
461 (gnus-registry-get-id-key reference 'group))
462 (registry-lookup-secondary-value db 'subject subject)))))
464 (loop for group in groups
465 when (gnus-registry-follow-group-p group)
467 ;; warn more if gnus-registry-track-extra
468 (if gnus-registry-track-extra 7 9)
469 "%s (extra tracking) traced subject '%s' to %s"
470 log-agent subject group)
472 ;; filter the found groups and return them
473 ;; the found groups are NOT the full groups
474 (setq found (gnus-registry-post-process-groups
475 "subject" subject found))))
477 ;; else: there were no matches, try the extra tracking by sender
478 (when (and (null found)
479 (memq 'sender gnus-registry-track-extra)
481 (not (gnus-grep-in-list
483 gnus-registry-unfollowed-addresses)))
488 (gnus-registry-get-id-key reference 'group))
489 (registry-lookup-secondary-value db 'sender sender)))))
491 (loop for group in groups
492 when (gnus-registry-follow-group-p group)
494 ;; warn more if gnus-registry-track-extra
495 (if gnus-registry-track-extra 7 9)
496 "%s (extra tracking) traced sender '%s' to %s"
497 log-agent sender group)
500 ;; filter the found groups and return them
501 ;; the found groups are NOT the full groups
502 (setq found (gnus-registry-post-process-groups
503 "sender" sender found)))
505 ;; else: there were no matches, try the extra tracking by recipient
506 (when (and (null found)
507 (memq 'recipient gnus-registry-track-extra)
509 (dolist (recp recipients)
510 (when (and (null found)
511 (not (gnus-grep-in-list
513 gnus-registry-unfollowed-addresses)))
514 (let ((groups (apply 'append
517 (gnus-registry-get-id-key reference 'group))
518 (registry-lookup-secondary-value
519 db 'recipient recp)))))
521 (loop for group in groups
522 when (gnus-registry-follow-group-p group)
524 ;; warn more if gnus-registry-track-extra
525 (if gnus-registry-track-extra 7 9)
526 "%s (extra tracking) traced recipient '%s' to %s"
527 log-agent recp group)
530 ;; filter the found groups and return them
531 ;; the found groups are NOT the full groups
532 (setq found (gnus-registry-post-process-groups
533 "recipients" (mapconcat 'identity recipients ", ") found)))
535 ;; after the (cond) we extract the actual value safely
538 (defun gnus-registry-post-process-groups (mode key groups)
539 "Inspects GROUPS found by MODE for KEY to determine which ones to follow.
541 MODE can be 'subject' or 'sender' for example. The KEY is the
542 value by which MODE was searched.
544 Transforms each group name to the equivalent short name.
546 Checks if the current Gnus method (from `gnus-command-method' or
547 from `gnus-newsgroup-name') is the same as the group's method.
548 Foreign methods are not supported so they are rejected.
550 Reduces the list to a single group, or complains if that's not
551 possible. Uses `gnus-registry-split-strategy'."
552 (let ((log-agent "gnus-registry-post-process-group")
553 (desc (format "%d groups" (length groups)))
555 ;; the strategy can be nil, in which case chosen is nil
557 (case gnus-registry-split-strategy
558 ;; default, take only one-element lists into chosen
560 (and (= (length groups) 1)
567 (let ((freq (make-hash-table
570 (mapc (lambda (x) (let ((x (gnus-group-short-name x)))
571 (puthash x (1+ (gethash x freq 0)) freq)))
573 (setq desc (format "%d groups, %d unique"
575 (hash-table-count freq)))
579 (> (gethash (gnus-group-short-name a) freq 0)
580 (gethash (gnus-group-short-name b) freq 0)))))))))
585 "%s: strategy %s on %s produced %s"
586 log-agent gnus-registry-split-strategy desc chosen)
589 "%s: strategy %s on %s did not produce an answer"
591 (or gnus-registry-split-strategy "default")
594 (setq groups (and chosen (list chosen)))
596 (dolist (group groups)
597 (let ((m1 (gnus-find-method-for-group group))
598 (m2 (or gnus-command-method
599 (gnus-find-method-for-group gnus-newsgroup-name)))
600 (short-name (gnus-group-short-name group)))
601 (if (gnus-methods-equal-p m1 m2)
603 ;; this is REALLY just for debugging
604 (when (not (equal group short-name))
607 "%s: stripped group %s to %s"
608 log-agent group short-name))
609 (add-to-list 'out short-name))
613 "%s: ignored foreign group %s"
616 (setq out (delq nil out))
619 ((= (length out) 1) out)
623 "%s: no matches for %s '%s'."
628 "%s: too many extra matches (%s) for %s '%s'. Returning none."
629 log-agent out mode key)
632 (defun gnus-registry-follow-group-p (group)
633 "Determines if a group name should be followed.
634 Consults `gnus-registry-unfollowed-groups' and
635 `nnmail-split-fancy-with-parent-ignore-groups'."
637 (not (or (gnus-grep-in-list
639 gnus-registry-unfollowed-groups)
642 nnmail-split-fancy-with-parent-ignore-groups)))))
644 (defun gnus-registry-wash-for-keywords (&optional force)
645 "Get the keywords of the current article.
646 Overrides existing keywords with FORCE set non-nil."
648 (let ((id (gnus-registry-fetch-message-id-fast gnus-current-article))
650 (if (or (not (gnus-registry-get-id-key id 'keyword))
652 (with-current-buffer gnus-article-buffer
654 (save-window-excursion
656 (narrow-to-region (point) (point-max))
657 (with-syntax-table gnus-adaptive-word-syntax-table
658 (while (re-search-forward "\\b\\w+\\b" nil t)
659 (setq word (gnus-string-remove-all-properties
660 (downcase (buffer-substring
661 (match-beginning 0) (match-end 0)))))
662 (if (> (length word) 2)
663 (push word words))))))
664 (gnus-registry-set-id-key id 'keyword words)))))
666 (defun gnus-registry-keywords ()
667 (let ((table (registry-lookup-secondary gnus-registry-db 'keyword)))
668 (when table (maphash (lambda (k v) k) table))))
670 (defun gnus-registry-find-keywords (keyword)
672 (completing-read "Keyword: " (gnus-registry-keywords) nil t)))
673 (registry-lookup-secondary-value gnus-registry-db 'keyword keyword))
675 (defun gnus-registry-register-message-ids ()
676 "Register the Message-ID of every article in the group"
677 (unless (gnus-parameter-registry-ignore gnus-newsgroup-name)
678 (dolist (article gnus-newsgroup-articles)
679 (let* ((id (gnus-registry-fetch-message-id-fast article))
680 (groups (gnus-registry-get-id-key id 'group)))
681 (unless (member gnus-newsgroup-name groups)
682 (gnus-message 9 "Registry: Registering article %d with group %s"
683 article gnus-newsgroup-name)
684 (gnus-registry-handle-action id nil gnus-newsgroup-name
685 (gnus-registry-fetch-simplified-message-subject-fast article)
686 (gnus-registry-fetch-sender-fast article)
687 (gnus-registry-fetch-recipients-fast article)))))))
689 ;; message field fetchers
690 (defun gnus-registry-fetch-message-id-fast (article)
691 "Fetch the Message-ID quickly, using the internal gnus-data-list function"
692 (if (and (numberp article)
693 (assoc article (gnus-data-list nil)))
694 (mail-header-id (gnus-data-header (assoc article (gnus-data-list nil))))
697 (defun gnus-registry-extract-addresses (text)
698 "Extract all the addresses in a normalized way from TEXT.
699 Returns an unsorted list of strings in the name <address> format.
700 Addresses without a name will say \"noname\"."
701 (mapcar (lambda (add)
702 (gnus-string-remove-all-properties
703 (let* ((name (or (nth 0 add) "noname"))
705 (addr (if (bufferp addr)
706 (with-current-buffer addr
709 (format "%s <%s>" name addr))))
710 (mail-extract-address-components text t)))
712 (defun gnus-registry-sort-addresses (&rest addresses)
713 "Return a normalized and sorted list of ADDRESSES."
714 (sort (apply 'nconc (mapcar 'gnus-registry-extract-addresses addresses))
717 (defun gnus-registry-simplify-subject (subject)
718 (if (stringp subject)
719 (gnus-simplify-subject subject)
722 (defun gnus-registry-fetch-simplified-message-subject-fast (article)
723 "Fetch the Subject quickly, using the internal gnus-data-list function"
724 (if (and (numberp article)
725 (assoc article (gnus-data-list nil)))
726 (gnus-string-remove-all-properties
727 (gnus-registry-simplify-subject
728 (mail-header-subject (gnus-data-header
729 (assoc article (gnus-data-list nil))))))
732 (defun gnus-registry-fetch-sender-fast (article)
733 (gnus-registry-fetch-header-fast "from" article))
735 (defun gnus-registry-fetch-recipients-fast (article)
736 (gnus-registry-sort-addresses
737 (or (ignore-errors (gnus-registry-fetch-header-fast "Cc" article)) "")
738 (or (ignore-errors (gnus-registry-fetch-header-fast "To" article)) "")))
740 (defun gnus-registry-fetch-header-fast (article header)
741 "Fetch the HEADER quickly, using the internal gnus-data-list function"
742 (if (and (numberp article)
743 (assoc article (gnus-data-list nil)))
744 (gnus-string-remove-all-properties
745 (mail-header header (gnus-data-header
746 (assoc article (gnus-data-list nil)))))
749 ;; registry marks glue
750 (defun gnus-registry-do-marks (type function)
751 "For each known mark, call FUNCTION for each cell of type TYPE.
753 FUNCTION should take two parameters, a mark symbol and the cell value."
754 (dolist (mark-info gnus-registry-marks)
755 (let* ((mark (car-safe mark-info))
756 (data (cdr-safe mark-info))
757 (cell-data (plist-get data type)))
759 (funcall function mark cell-data)))))
761 ;;; this is ugly code, but I don't know how to do it better
762 (defun gnus-registry-install-shortcuts ()
763 "Install the keyboard shortcuts and menus for the registry.
764 Uses `gnus-registry-marks' to find what shortcuts to install."
766 (setq gnus-registry-misc-menus nil)
767 (gnus-registry-do-marks
770 (let ((function-format
771 (format "gnus-registry-%%s-article-%s-mark" mark)))
773 ;;; The following generates these functions:
774 ;;; (defun gnus-registry-set-article-Important-mark (&rest articles)
775 ;;; "Apply the Important mark to process-marked ARTICLES."
776 ;;; (interactive (gnus-summary-work-articles current-prefix-arg))
777 ;;; (gnus-registry-set-article-mark-internal 'Important articles nil t))
778 ;;; (defun gnus-registry-remove-article-Important-mark (&rest articles)
779 ;;; "Apply the Important mark to process-marked ARTICLES."
780 ;;; (interactive (gnus-summary-work-articles current-prefix-arg))
781 ;;; (gnus-registry-set-article-mark-internal 'Important articles t t))
783 (dolist (remove '(t nil))
784 (let* ((variant-name (if remove "remove" "set"))
785 (function-name (format function-format variant-name))
786 (shortcut (format "%c" data))
787 (shortcut (if remove (upcase shortcut) shortcut)))
788 (unintern function-name obarray)
792 ,(intern function-name)
793 ;; parameter definition
797 "%s the %s mark over process-marked ARTICLES."
798 (upcase-initials variant-name)
800 ;; interactive definition
802 (gnus-summary-work-articles current-prefix-arg))
805 ;; if this is called and the user doesn't want the
806 ;; registry enabled, we'll ask anyhow
807 (when (eq gnus-registry-install nil)
808 (setq gnus-registry-install 'ask))
810 ;; now the user is asked if gnus-registry-install is 'ask
811 (when (gnus-registry-install-p)
812 (gnus-registry-set-article-mark-internal
813 ;; all this just to get the mark, I must be doing it wrong
814 (intern ,(symbol-name mark))
818 "Applying mark %s to %d articles"
819 ,(symbol-name mark) (length articles))
820 (dolist (article articles)
821 (gnus-summary-update-article
823 (assoc article (gnus-data-list nil)))))))
824 (push (intern function-name) keys-plist)
825 (push shortcut keys-plist)
826 (push (vector (format "%s %s"
827 (upcase-initials variant-name)
829 (intern function-name) t)
830 gnus-registry-misc-menus)
833 "Defined mark handling function %s"
836 '(gnus-registry-mark-map "M" gnus-summary-mark-map)
838 (add-hook 'gnus-summary-menu-hook
841 gnus-summary-misc-menu
843 (cons "Registry Marks" gnus-registry-misc-menus))))))
846 ;;; (defalias 'gnus-user-format-function-M
847 ;;; 'gnus-registry-user-format-function-M)
848 (defun gnus-registry-user-format-function-M (headers)
849 (let* ((id (mail-header-message-id headers))
850 (marks (when id (gnus-registry-get-id-key id 'mark))))
851 (apply 'concat (mapcar (lambda (mark)
855 (assoc mark gnus-registry-marks))
862 (defun gnus-registry-read-mark ()
863 "Read a mark name from the user with completion."
864 (let ((mark (gnus-completing-read
866 (mapcar 'symbol-name (mapcar 'car gnus-registry-marks))
868 (symbol-name gnus-registry-default-mark))))
872 (defun gnus-registry-set-article-mark (&rest articles)
873 "Apply a mark to process-marked ARTICLES."
874 (interactive (gnus-summary-work-articles current-prefix-arg))
875 (gnus-registry-set-article-mark-internal (gnus-registry-read-mark)
878 (defun gnus-registry-remove-article-mark (&rest articles)
879 "Remove a mark from process-marked ARTICLES."
880 (interactive (gnus-summary-work-articles current-prefix-arg))
881 (gnus-registry-set-article-mark-internal (gnus-registry-read-mark)
884 (defun gnus-registry-set-article-mark-internal (mark
888 "Apply or remove MARK across a list of ARTICLES."
889 (let ((article-id-list
890 (mapcar 'gnus-registry-fetch-message-id-fast articles)))
891 (dolist (id article-id-list)
892 (let* ((marks (delq mark (gnus-registry-get-id-key id 'mark)))
893 (marks (if remove marks (cons mark marks))))
895 (gnus-message 1 "%s mark %s with message ID %s, resulting in %S"
896 (if remove "Removing" "Adding")
898 (gnus-registry-set-id-key id 'mark marks)))))
900 (defun gnus-registry-get-article-marks (&rest articles)
901 "Get the Gnus registry marks for ARTICLES and show them if interactive.
902 Uses process/prefix conventions. For multiple articles,
903 only the last one's marks are returned."
904 (interactive (gnus-summary-work-articles 1))
905 (let* ((article (last articles))
906 (id (gnus-registry-fetch-message-id-fast article))
907 (marks (when id (gnus-registry-get-id-key id 'mark))))
908 (when (interactive-p)
909 (gnus-message 1 "Marks are %S" marks))
912 (defun gnus-registry-group-count (id)
913 "Get the number of groups of a message, based on the message ID."
914 (length (gnus-registry-get-id-key id 'group)))
916 (defun gnus-registry-get-or-make-entry (id)
917 (let* ((db gnus-registry-db)
919 (entries (registry-lookup db (list id))))
922 (registry-insert db id (list (list 'creation-time (current-time))
923 '(group) '(sender) '(subject)))
924 (setq entries (registry-lookup db (list id))))
926 (nth 1 (assoc id entries))))
928 (defun gnus-registry-delete-entries (idlist)
929 (registry-delete gnus-registry-db idlist nil))
931 (defun gnus-registry-get-id-key (id key)
932 (cdr-safe (assq key (gnus-registry-get-or-make-entry id))))
934 (defun gnus-registry-set-id-key (id key vals)
935 (let* ((db gnus-registry-db)
936 (entry (gnus-registry-get-or-make-entry id)))
937 (registry-delete db (list id) nil)
938 (setq entry (cons (cons key vals) (assq-delete-all key entry)))
939 (registry-insert db id entry)
942 (defun gnus-registry-import-eld (file)
943 (interactive "fOld registry file to import? ")
945 ;; (setq gnus-registry-alist '(
946 ;; ("<messageID>" ((marks nil)
947 ;; (mtime 19365 1776 440496)
948 ;; (sender . "root (Cron Daemon)")
949 ;; (subject . "Cron"))
950 ;; "cron" "nnml+private:cron")
952 (when (boundp 'gnus-registry-alist)
953 (let* ((old (symbol-value 'gnus-registry-alist))
955 (expected (length old))
957 (while (car-safe old)
959 ;; don't use progress reporters for backwards compatibility
960 (when (and (< 0 expected)
961 (= 0 (mod count 100)))
962 (message "importing: %d of %d (%.2f%%)"
963 count expected (/ (* 100 count) expected)))
964 (setq entry (car-safe old)
966 (let* ((id (car-safe entry))
967 (new-entry (gnus-registry-get-or-make-entry id))
968 (rest (cdr-safe entry))
969 (groups (loop for p in rest
973 ;; remove all the strings from the entry
975 (if (stringp elem) (setq rest (delq elem rest))))
976 (gnus-registry-set-id-key id 'group groups)
977 ;; just use the first extra element
978 (setq rest (car-safe rest))
979 (while (car-safe rest)
980 (setq extra-cell (car-safe rest)
981 key (car-safe extra-cell)
982 val (cdr-safe extra-cell)
983 rest (cdr-safe rest))
984 (when (and val (atom val))
985 (setq val (list val)))
986 (gnus-registry-set-id-key id key val))))
987 (message "Import done, collected %d entries" count))))
989 (ert-deftest gnus-registry-misc-test ()
990 (should-error (gnus-registry-extract-addresses '("" "")))
992 (should (equal '("Ted Zlatanov <tzz@lifelogs.com>"
994 "noname <cyd@stupidchicken.com>"
995 "noname <tzz@lifelogs.com>")
996 (gnus-registry-extract-addresses
997 (concat "Ted Zlatanov <tzz@lifelogs.com>, "
998 "ed <ed@you.me>, " ; "ed" is not a valid name here
999 "cyd@stupidchicken.com, "
1000 "tzz@lifelogs.com")))))
1002 (ert-deftest gnus-registry-usage-test ()
1004 (tempfile (make-temp-file "gnus-registry-persist"))
1005 (db (gnus-registry-make-db tempfile))
1006 (gnus-registry-db db)
1008 (message "Adding %d keys to the test Gnus registry" n)
1010 (let ((id (number-to-string i)))
1011 (gnus-registry-handle-action id
1012 (if (>= 50 i) "fromgroup" nil)
1015 (format "subject %d" (mod i 10)))
1017 (format "sender %d" (mod i 10))))))
1018 (message "Testing Gnus registry size is %d" n)
1019 (should (= n (registry-size db)))
1020 (message "Looking up individual keys (registry-lookup)")
1021 (should (equal (loop for e
1023 (registry-lookup db '("20" "83" "72")))
1024 collect (assq 'subject e)
1025 collect (assq 'sender e)
1026 collect (assq 'group e))
1027 '((subject "subject 0") (sender "sender 0") (group "togroup")
1028 (subject) (sender) (group "togroup")
1029 (subject) (sender "sender 2") (group "togroup"))))
1031 (message "Looking up individual keys (gnus-registry-id-key)")
1032 (should (equal (gnus-registry-get-id-key "34" 'group) '("togroup")))
1033 (should (equal (gnus-registry-get-id-key "34" 'subject) '("subject 4")))
1034 (message "Trying to insert a duplicate key")
1035 (should-error (registry-insert db "55" '()))
1036 (message "Looking up individual keys (gnus-registry-get-or-make-entry)")
1037 (should (gnus-registry-get-or-make-entry "22"))
1038 (message "Saving the Gnus registry to %s" tempfile)
1039 (should (gnus-registry-save tempfile db))
1040 (setq size (nth 7 (file-attributes tempfile)))
1041 (message "Saving the Gnus registry to %s: size %d" tempfile size)
1044 (insert-file-contents-literally tempfile)
1045 (should (looking-at (concat ";; Object "
1047 "\n;; EIEIO PERSISTENT OBJECT"))))
1048 (message "Reading Gnus registry back")
1049 (setq back (eieio-persistent-read tempfile))
1051 (message "Read Gnus registry back: %d keys, expected %d==%d"
1052 (registry-size back) n (registry-size db))
1053 (should (= (registry-size back) n))
1054 (should (= (registry-size back) (registry-size db)))
1055 (delete-file tempfile)
1056 (message "Pruning Gnus registry to 0 by setting :max-soft")
1057 (oset db :max-soft 0)
1059 (should (= (registry-size db) 0)))
1060 (message "Done with Gnus registry usage testing."))
1063 (defun gnus-registry-initialize ()
1064 "Initialize the Gnus registry."
1066 (gnus-message 5 "Initializing the registry")
1067 (setq gnus-registry-install t) ; in case it was 'ask or nil
1068 (gnus-registry-install-hooks)
1069 (gnus-registry-install-shortcuts)
1070 (gnus-registry-read))
1073 (defun gnus-registry-install-hooks ()
1074 "Install the registry hooks."
1076 (add-hook 'gnus-summary-article-move-hook 'gnus-registry-action)
1077 (add-hook 'gnus-summary-article-delete-hook 'gnus-registry-action)
1078 (add-hook 'gnus-summary-article-expire-hook 'gnus-registry-action)
1079 (add-hook 'nnmail-spool-hook 'gnus-registry-spool-action)
1081 (add-hook 'gnus-save-newsrc-hook 'gnus-registry-save)
1082 (add-hook 'gnus-read-newsrc-el-hook 'gnus-registry-read)
1084 (add-hook 'gnus-summary-prepare-hook 'gnus-registry-register-message-ids))
1086 (defun gnus-registry-unload-hook ()
1087 "Uninstall the registry hooks."
1089 (remove-hook 'gnus-summary-article-move-hook 'gnus-registry-action)
1090 (remove-hook 'gnus-summary-article-delete-hook 'gnus-registry-action)
1091 (remove-hook 'gnus-summary-article-expire-hook 'gnus-registry-action)
1092 (remove-hook 'nnmail-spool-hook 'gnus-registry-spool-action)
1094 (remove-hook 'gnus-save-newsrc-hook 'gnus-registry-save)
1095 (remove-hook 'gnus-read-newsrc-el-hook 'gnus-registry-read)
1097 (remove-hook 'gnus-summary-prepare-hook 'gnus-registry-register-message-ids))
1099 (add-hook 'gnus-registry-unload-hook 'gnus-registry-unload-hook)
1101 (defun gnus-registry-install-p ()
1103 (when (eq gnus-registry-install 'ask)
1104 (setq gnus-registry-install
1106 (concat "Enable the Gnus registry? "
1107 "See the variable `gnus-registry-install' "
1108 "to get rid of this query permanently. ")))
1109 (when gnus-registry-install
1110 ;; we just set gnus-registry-install to t, so initialize the registry!
1111 (gnus-registry-initialize)))
1112 ;;; we could call it here: (customize-variable 'gnus-registry-install)
1113 gnus-registry-install)
1115 ;; TODO: a few things
1117 (provide 'gnus-registry)
1119 ;;; gnus-registry.el ends here