Import Gnus v5.10.2.
[elisp/gnus.git-] / lisp / gnus-registry.el
index 324155d..e97b1e4 100644 (file)
 (defvar gnus-registry-hashtb nil
   "*The article registry by Message ID.")
 
-(defvar gnus-registry-headers-hashtb nil
-  "*The article header registry by Message ID.  Unused for now.")
-
 (defcustom gnus-registry-unfollowed-groups '("delayed" "drafts" "queue")
   "List of groups that gnus-registry-split-fancy-with-parent won't follow.
 The group names are matched, they don't have to be fully qualified."
   :group 'gnus-registry
   :type '(repeat string))
 
-(defcustom gnus-registry-unregistered-group-regex "^nntp"
-  "Group name regex that gnus-registry-register-message-ids won't process."
+(defcustom gnus-registry-install nil
+  "Whether the registry should be installed."
+  :group 'gnus-registry
+  :type 'boolean)
+
+(defcustom gnus-registry-cache-file "~/.gnus.registry.eld"
+  "File where the Gnus registry will be stored."
   :group 'gnus-registry
-  :type 'regexp)
+  :type 'file)
 
 ;; Function(s) missing in Emacs 20
 (when (memq nil (mapcar 'fboundp '(puthash)))
@@ -61,10 +63,96 @@ The group names are matched, they don't have to be fully qualified."
     ;; alias puthash is missing from Emacs 20 cl-extra.el
     (defalias 'puthash 'cl-puthash)))
 
-(defun gnus-registry-translate-to-alist ()
-  (setq gnus-registry-alist (hashtable-to-alist gnus-registry-hashtb)))
-
-(defun gnus-registry-translate-from-alist ()
+(defun gnus-registry-cache-read ()
+  "Read the registry cache file."
+  (interactive)
+  (let ((file gnus-registry-cache-file))
+    (when (file-exists-p file)
+      (gnus-message 5 "Reading %s..." file)
+      (gnus-load file)
+      (gnus-message 5 "Reading %s...done" file))))
+
+(defun gnus-registry-cache-save ()
+  "Save the registry cache file."
+  (interactive)
+  (let ((file gnus-registry-cache-file))
+    (save-excursion
+      ;; Save .newsrc.eld.
+      (set-buffer (gnus-get-buffer-create " *Gnus-registry-cache*"))
+      (make-local-variable 'version-control)
+    (setq version-control gnus-backup-startup-file)
+    (setq buffer-file-name file)
+    (setq default-directory (file-name-directory buffer-file-name))
+    (buffer-disable-undo)
+    (erase-buffer)
+    (gnus-message 5 "Saving %s..." file)
+    (if gnus-save-startup-file-via-temp-buffer
+       (let ((coding-system-for-write gnus-ding-file-coding-system)
+             (standard-output (current-buffer)))
+         (gnus-gnus-to-quick-newsrc-format t "gnus registry startup file" 'gnus-registry-alist)
+         (gnus-registry-cache-whitespace file)
+         (save-buffer))
+      (let ((coding-system-for-write gnus-ding-file-coding-system)
+           (version-control gnus-backup-startup-file)
+           (startup-file file)
+           (working-dir (file-name-directory file))
+           working-file
+           (i -1))
+       ;; Generate the name of a non-existent file.
+       (while (progn (setq working-file
+                           (format
+                            (if (and (eq system-type 'ms-dos)
+                                     (not (gnus-long-file-names)))
+                                "%s#%d.tm#" ; MSDOS limits files to 8+3
+                              (if (memq system-type '(vax-vms axp-vms))
+                                  "%s$tmp$%d"
+                                "%s#tmp#%d"))
+                            working-dir (setq i (1+ i))))
+                     (file-exists-p working-file)))
+       
+       (unwind-protect
+           (progn
+             (gnus-with-output-to-file working-file
+               (gnus-gnus-to-quick-newsrc-format t "gnus registry startup file" 'gnus-registry-alist))
+             
+             ;; These bindings will mislead the current buffer
+             ;; into thinking that it is visiting the startup
+             ;; file.
+             (let ((buffer-backed-up nil)
+                   (buffer-file-name startup-file)
+                   (file-precious-flag t)
+                   (setmodes (file-modes startup-file)))
+               ;; Backup the current version of the startup file.
+               (backup-buffer)
+               
+               ;; Replace the existing startup file with the temp file.
+               (rename-file working-file startup-file t)
+               (set-file-modes startup-file setmodes)))
+         (condition-case nil
+             (delete-file working-file)
+           (file-error nil)))))
+    
+    (gnus-kill-buffer (current-buffer))
+    (gnus-message 5 "Saving %s...done" file))))
+
+;; Idea from Dan Christensen <jdc@chow.mat.jhu.edu>
+;; Save the gnus-registry file with extra line breaks.
+(defun gnus-registry-cache-whitespace (filename)
+  (gnus-message 4 "Adding whitespace to %s" filename)
+  (save-excursion
+    (goto-char (point-min))
+    (while (re-search-forward "^(\\|(\\\"" nil t)
+      (replace-match "\n\\&" t))
+    (goto-char (point-min))
+    (while (re-search-forward " $" nil t)
+      (replace-match "" t t))))
+
+(defun gnus-registry-save ()
+  (setq gnus-registry-alist (hashtable-to-alist gnus-registry-hashtb))
+  (gnus-registry-cache-save))
+
+(defun gnus-registry-read ()
+  (gnus-registry-cache-read)
   (setq gnus-registry-hashtb (alist-to-hashtable gnus-registry-alist)))
 
 (defun alist-to-hashtable (alist)
@@ -134,8 +222,11 @@ see which group that message was put in.  This group is returned.
 See the Info node `(gnus)Fancy Mail Splitting' for more details."
   (let ((refstr (or (message-fetch-field "references")
                    (message-fetch-field "in-reply-to")))
-       (references nil)
-       (res nil))
+       (nnmail-split-fancy-with-parent-ignore-groups
+        (if (listp nnmail-split-fancy-with-parent-ignore-groups)
+            nnmail-split-fancy-with-parent-ignore-groups
+          (list nnmail-split-fancy-with-parent-ignore-groups)))
+       references res)
     (when refstr
       (setq references (nreverse (gnus-split-references refstr)))
       (mapcar (lambda (x)
@@ -156,8 +247,7 @@ See the Info node `(gnus)Fancy Mail Splitting' for more details."
 
 (defun gnus-registry-register-message-ids ()
   "Register the Message-ID of every article in the group"
-  (unless (and gnus-registry-unregistered-group-regex
-              (string-match gnus-registry-unregistered-group-regex gnus-newsgroup-name))
+  (unless (gnus-parameter-registry-ignore gnus-newsgroup-name)
     (dolist (article gnus-newsgroup-articles)
       (let ((id (gnus-registry-fetch-message-id-fast article)))
        (unless (gnus-registry-fetch-group id)
@@ -182,18 +272,56 @@ See the Info node `(gnus)Fancy Mail Splitting' for more details."
                     (string-match x word))
                   list)))))
 
+(defun gnus-registry-fetch-extra (id &optional entry)
+  "Get the extra data of a message, based on the message ID.
+Returns the first place where the trail finds a nonstring."
+  (let ((trail (gethash id gnus-registry-hashtb)))
+    (dolist (crumb trail)
+      (unless (stringp crumb)
+       (return (gnus-registry-fetch-extra-entry crumb entry))))))
+
+(defun gnus-registry-fetch-extra-entry (alist &optional entry)
+  "Get the extra data of a message, or a specific entry in it."
+  (if entry
+      (assq entry alist)
+    alist))
+
+(defun gnus-registry-store-extra (id extra)
+  "Store the extra data of a message, based on the message ID.
+The message must have at least one group name."
+  (when (gnus-registry-group-count id)
+    ;; we now know the trail has at least 1 group name, so it's not empty
+    (let ((trail (gethash id gnus-registry-hashtb))
+         (old-extra (gnus-registry-fetch-extra id)))
+      (puthash id (cons extra (delete old-extra trail))
+              gnus-registry-hashtb))))
+
+(defun gnus-registry-store-extra-entry (id key value)
+  "Put a specific entry in the extras field of the registry entry for id."
+  (let* ((extra (gnus-registry-fetch-extra id))
+        (alist (cons (cons key value)
+                (gnus-assq-delete-all key (gnus-registry-fetch-extra id)))))
+    (gnus-registry-store-extra id alist)))
+
 (defun gnus-registry-fetch-group (id)
   "Get the group of a message, based on the message ID.
-Returns the first place where the trail finds a spool action."
-  (when id
+Returns the first place where the trail finds a group name."
+  (when (gnus-registry-group-count id)
+    ;; we now know the trail has at least 1 group name
     (let ((trail (gethash id gnus-registry-hashtb)))
-      (if trail
-         (car trail)
-       nil))))
+      (dolist (crumb trail)
+       (when (stringp crumb)
+         (return crumb))))))
+
+(defun gnus-registry-group-count (id)
+  "Get the number of groups of a message, based on the message ID."
+  (let ((trail (gethash id gnus-registry-hashtb)))
+    (if (and trail (listp trail))
+       (apply '+ (mapcar (lambda (x) (if (stringp x) 1 0)) trail))
+      0)))
 
 (defun gnus-registry-delete-group (id group)
-  "Get the group of a message, based on the message ID.
-Returns the first place where the trail finds a spool action."
+  "Delete a group for a message, based on the message ID."
   (when group
     (when id
       (let ((trail (gethash id gnus-registry-hashtb))
@@ -202,41 +330,48 @@ Returns the first place where the trail finds a spool action."
                        (delete group trail)
                      nil)
                 gnus-registry-hashtb))
-      ;; now, clear the entry if it's empty
-      (unless (gethash id gnus-registry-hashtb)
-       (remhash id gnus-registry-hashtb)))))
+      ;; now, clear the entry if there are no more groups
+      (unless (gnus-registry-group-count id)
+       (remhash id gnus-registry-hashtb))
+      (gnus-registry-store-extra-entry id 'mtime (current-time)))))
 
-(defun gnus-registry-add-group (id group)
-  "Get the group of a message, based on the message ID.
-Returns the first place where the trail finds a spool action."
+(defun gnus-registry-add-group (id group &rest extra)
+  "Add a group for a message, based on the message ID."
   ;; make sure there are no duplicate entries
   (when group
-    (when id
+    (when (and id
+              (not (string-match "totally-fudged-out-message-id" id)))
       (let ((group (gnus-group-short-name group)))
        (gnus-registry-delete-group id group)   
        (let ((trail (gethash id gnus-registry-hashtb)))
          (puthash id (if trail
                          (cons group trail)
                        (list group))
-                  gnus-registry-hashtb))))))
+                  gnus-registry-hashtb)
+         (when extra (gnus-registry-store-extra id extra))
+         (gnus-registry-store-extra-entry id 'mtime (current-time)))))))
 
 (defun gnus-registry-clear ()
   "Clear the Gnus registry."
   (interactive)
-  (setq gnus-registry-alist nil 
-       gnus-registry-headers-alist nil)
-  (gnus-registry-translate-from-alist))
-
-; also does copy, respool, and crosspost
-(add-hook 'gnus-summary-article-move-hook 'gnus-register-action) 
-(add-hook 'gnus-summary-article-delete-hook 'gnus-register-action)
-(add-hook 'gnus-summary-article-expire-hook 'gnus-register-action)
-(add-hook 'nnmail-spool-hook 'gnus-register-spool-action)
-
-(add-hook 'gnus-save-newsrc-hook 'gnus-registry-translate-to-alist)
-(add-hook 'gnus-read-newsrc-el-hook 'gnus-registry-translate-from-alist)
+  (setq gnus-registry-alist nil)
+  (setq gnus-registry-hashtb (alist-to-hashtable gnus-registry-alist)))
 
-(add-hook 'gnus-summary-prepare-hook 'gnus-registry-register-message-ids)
+(defun gnus-registry-install-hooks ()
+  "Install the registry hooks."
+  (interactive)
+  (add-hook 'gnus-summary-article-move-hook 'gnus-register-action) 
+  (add-hook 'gnus-summary-article-delete-hook 'gnus-register-action)
+  (add-hook 'gnus-summary-article-expire-hook 'gnus-register-action)
+  (add-hook 'nnmail-spool-hook 'gnus-register-spool-action)
+  
+  (add-hook 'gnus-save-newsrc-hook 'gnus-registry-save)
+  (add-hook 'gnus-read-newsrc-el-hook 'gnus-registry-read)
+
+  (add-hook 'gnus-summary-prepare-hook 'gnus-registry-register-message-ids))
+
+(when gnus-registry-install
+  (gnus-registry-install-hooks))
 
 ;; TODO: a lot of things