*** empty log message ***
[gnus] / lisp / nnmail.el
index a27464a..ec8b82a 100644 (file)
@@ -138,7 +138,11 @@ links, you could set this variable to `copy-file' instead.")
 
 (defvar nnmail-movemail-program "movemail"
   "*A command to be executed to move mail from the inbox.
-The default is \"movemail\".")
+The default is \"movemail\".
+
+This can also be a function.  In that case, the function will be
+called with two parameters -- the name of the INBOX file, and the file
+to be moved to.")
 
 (defvar nnmail-pop-password-required nil
   "*Non-nil if a password is required when reading mail using POP.")
@@ -147,7 +151,7 @@ The default is \"movemail\".")
   "*Hook that will be run after the incoming mail has been transferred.
 The incoming mail is moved from `nnmail-spool-file' (which normally is
 something like \"/usr/spool/mail/$user\") to the user's home
-directory. This hook is called after the incoming mail box has been
+directory.  This hook is called after the incoming mail box has been
 emptied, and can be used to call any mail box programs you have
 running (\"xwatch\", etc.)
 
@@ -178,6 +182,18 @@ If you use `display-time', you could use something like this:
   "*Hook called before treating incoming mail.
 The hook is run in a buffer with all the new, incoming mail.")
 
+(defvar nnmail-prepare-incoming-header-hook nil
+  "*Hook called narrowed to the headers of each message.
+This can be used to remove excessive spaces (and stuff like
+that) from the headers before splitting and saving the messages.")
+
+(defvar nnmail-prepare-incoming-message-hook nil
+  "*Hook called narrowed to each message.")
+
+(defvar nnmail-list-identifiers nil
+  "Regexp that match list identifiers to be removed.
+This can also be a list of regexps.")
+
 (defvar nnmail-pre-get-new-mail-hook nil
   "Hook called just before starting to handle new incoming mail.")
 
@@ -228,7 +244,7 @@ Example:
 
 \(setq nnmail-split-methods 'nnmail-split-fancy
       nnmail-split-fancy
-      ;; Messages from the mailer deamon are not crossposted to any of
+      ;; Messages from the mailer daemon are not crossposted to any of
       ;; the ordinary groups.  Warnings are put in a separate group
       ;; from real errors.
       '(| (\"from\" mail (| (\"subject\" \"warn.*\" \"mail.warning\")
@@ -275,6 +291,9 @@ parameter.  It should return nil, `warn' or `delete'.")
 
 ;;; Internal variables.
 
+(defvar nnmail-split-history nil
+  "List of group/article elements that say where the previous split put messages.")
+
 (defvar nnmail-pop-password nil
   "*Password to use when reading mail from a POP server, if required.")
 
@@ -366,107 +385,114 @@ parameter.  It should return nil, `warn' or `delete'.")
 ;; Function rewritten from rmail.el.
 (defun nnmail-move-inbox (inbox)
   "Move INBOX to `nnmail-crash-box'."
-  (let ((inbox (file-truename (expand-file-name inbox)))
-       (tofile (file-truename (expand-file-name nnmail-crash-box)))
-       movemail popmail errors password)
-    ;; If getting from mail spool directory,
-    ;; use movemail to move rather than just renaming,
-    ;; so as to interlock with the mailer.
-    (unless (setq popmail (string-match "^po:" (file-name-nondirectory inbox)))
-      (setq movemail t))
-    (when popmail 
-      (setq inbox (file-name-nondirectory inbox)))
-    (when (and movemail
-              ;; On some systems, /usr/spool/mail/foo is a directory
-              ;; and the actual inbox is /usr/spool/mail/foo/foo.
-              (file-directory-p inbox))
-      (setq inbox (expand-file-name (user-login-name) inbox)))
-    (if (member inbox nnmail-moved-inboxes)
-       nil
-      (if popmail
-         (progn
-           (setq nnmail-internal-password nnmail-pop-password)
-           (when (and nnmail-pop-password-required (not nnmail-pop-password))
-             (setq nnmail-internal-password
-                   (nnmail-read-passwd
-                    (format "Password for %s: "
-                            (substring inbox (+ popmail 3))))))
-           (message "Getting mail from post office ..."))
-       (when (or (and (file-exists-p tofile)
-                      (/= 0 (nnheader-file-size tofile)))
-                 (and (file-exists-p inbox)
-                      (/= 0 (nnheader-file-size inbox))))
-         (message "Getting mail from %s..." inbox)))
-      ;; Set TOFILE if have not already done so, and
-      ;; rename or copy the file INBOX to TOFILE if and as appropriate.
-      (cond 
-       ((file-exists-p tofile)
-       ;; The crash box exists already.
-       t)
-       ((and (not popmail)
-            (not (file-exists-p inbox)))
-       ;; There is no inbox.
-       (setq tofile nil))
-       ((and (not movemail) (not popmail))
-       ;; Try copying.  If that fails (perhaps no space),
-       ;; rename instead.
-       (condition-case nil
-           (copy-file inbox tofile nil)
-         (error
-          ;; Third arg is t so we can replace existing file TOFILE.
-          (rename-file inbox tofile t)))
-       (push inbox nnmail-moved-inboxes)
-       ;; Make the real inbox file empty.
-       ;; Leaving it deleted could cause lossage
-       ;; because mailers often won't create the file.
-       (condition-case ()
-           (write-region (point) (point) inbox)
-         (file-error nil)))
-       (t
-       ;; Use movemail.
-       (unwind-protect
-           (save-excursion
-             (setq errors (generate-new-buffer " *nnmail loss*"))
-             (buffer-disable-undo errors)
-             (let ((default-directory "/"))
-               (apply 
-                'call-process
-                (append
-                 (list
-                  (expand-file-name nnmail-movemail-program exec-directory)
-                  nil errors nil inbox tofile)
-                 (when nnmail-internal-password
-                   (list nnmail-internal-password)))))
-             (if (not (buffer-modified-p errors))
-                 ;; No output => movemail won
-                 (progn
-                   (set-file-modes inbox nnmail-default-file-modes)
-                   (push inbox nnmail-moved-inboxes))
-               (set-buffer errors)
-               ;; There may be a warning about older revisions.  We
-               ;; ignore those.
-               (goto-char (point-min))
-               (if (search-forward "older revision" nil t)
+  (if (not (file-writable-p nnmail-crash-box))
+      (gnus-error 1 "Can't write to crash box %s.  Not moving mail."
+                 nnmail-crash-box)
+    (let ((inbox (file-truename (expand-file-name inbox)))
+         (tofile (file-truename (expand-file-name nnmail-crash-box)))
+         movemail popmail errors)
+      ;; If getting from mail spool directory,
+      ;; use movemail to move rather than just renaming,
+      ;; so as to interlock with the mailer.
+      (unless (setq popmail (string-match "^po:" (file-name-nondirectory inbox)))
+       (setq movemail t))
+      (when popmail 
+       (setq inbox (file-name-nondirectory inbox)))
+      (when (and movemail
+                ;; On some systems, /usr/spool/mail/foo is a directory
+                ;; and the actual inbox is /usr/spool/mail/foo/foo.
+                (file-directory-p inbox))
+       (setq inbox (expand-file-name (user-login-name) inbox)))
+      (if (member inbox nnmail-moved-inboxes)
+         nil
+       (if popmail
+           (progn
+             (setq nnmail-internal-password nnmail-pop-password)
+             (when (and nnmail-pop-password-required (not nnmail-pop-password))
+               (setq nnmail-internal-password
+                     (nnmail-read-passwd
+                      (format "Password for %s: "
+                              (substring inbox (+ popmail 3))))))
+             (message "Getting mail from post office ..."))
+         (when (or (and (file-exists-p tofile)
+                        (/= 0 (nnheader-file-size tofile)))
+                   (and (file-exists-p inbox)
+                        (/= 0 (nnheader-file-size inbox))))
+           (message "Getting mail from %s..." inbox)))
+       ;; Set TOFILE if have not already done so, and
+       ;; rename or copy the file INBOX to TOFILE if and as appropriate.
+       (cond 
+        ((file-exists-p tofile)
+         ;; The crash box exists already.
+         t)
+        ((and (not popmail)
+              (not (file-exists-p inbox)))
+         ;; There is no inbox.
+         (setq tofile nil))
+        ((and (not movemail) (not popmail))
+         ;; Try copying.  If that fails (perhaps no space),
+         ;; rename instead.
+         (condition-case nil
+             (copy-file inbox tofile nil)
+           (error
+            ;; Third arg is t so we can replace existing file TOFILE.
+            (rename-file inbox tofile t)))
+         (push inbox nnmail-moved-inboxes)
+         ;; Make the real inbox file empty.
+         ;; Leaving it deleted could cause lossage
+         ;; because mailers often won't create the file.
+         (condition-case ()
+             (write-region (point) (point) inbox)
+           (file-error nil)))
+        (t
+         ;; Use movemail.
+         (unwind-protect
+             (save-excursion
+               (setq errors (generate-new-buffer " *nnmail loss*"))
+               (buffer-disable-undo errors)
+               (let ((default-directory "/"))
+                 (if (nnheader-functionp nnmail-movemail-program)
+                     (funcall nnmail-movemail-program inbox tofile)
+                   (apply 
+                    'call-process
+                    (append
+                     (list
+                      (expand-file-name nnmail-movemail-program exec-directory)
+                      nil errors nil inbox tofile)
+                     (when nnmail-internal-password
+                       (list nnmail-internal-password))))))
+               (if (not (buffer-modified-p errors))
+                   ;; No output => movemail won
                    (progn
-                     (set-file-modes inbox nnmail-default-file-modes)
+                     (or popmail
+                         (set-file-modes tofile nnmail-default-file-modes))
                      (push inbox nnmail-moved-inboxes))
-                 ;; Probably a real error.
-                 (subst-char-in-region (point-min) (point-max) ?\n ?\  )
-                 (goto-char (point-max))
-                 (skip-chars-backward " \t")
-                 (delete-region (point) (point-max))
+                 (set-buffer errors)
+                 ;; There may be a warning about older revisions.  We
+                 ;; ignore those.
                  (goto-char (point-min))
-                 (when (looking-at "movemail: ")
-                   (delete-region (point-min) (match-end 0)))
-                 (unless (yes-or-no-p
-                          (format "movemail: %s.  Continue? "
-                                  (buffer-string)))
-                   (error "%s" (buffer-string)))
-                 (setq tofile nil)))))))
-      (and errors
-          (buffer-name errors)
-          (kill-buffer errors))
-      tofile)))
+                 (if (search-forward "older revision" nil t)
+                     (progn
+                       (or popmail
+                           (set-file-modes tofile nnmail-default-file-modes))
+                       (push inbox nnmail-moved-inboxes))
+                   ;; Probably a real error.
+                   (subst-char-in-region (point-min) (point-max) ?\n ?\  )
+                   (goto-char (point-max))
+                   (skip-chars-backward " \t")
+                   (delete-region (point) (point-max))
+                   (goto-char (point-min))
+                   (when (looking-at "movemail: ")
+                     (delete-region (point-min) (match-end 0)))
+                   (unless (yes-or-no-p
+                            (format "movemail: %s.  Continue? "
+                                    (buffer-string)))
+                     (error "%s" (buffer-string)))
+                   (setq tofile nil)))))))
+       (and errors
+            (buffer-name errors)
+            (kill-buffer errors))
+       tofile))))
 
 (defun nnmail-get-active ()
   "Returns an assoc of group names and active ranges.
@@ -488,34 +514,39 @@ nn*-request-list should have been called before calling this function."
 (defun nnmail-save-active (group-assoc file-name)
   "Save GROUP-ASSOC in ACTIVE-FILE."
   (when file-name
-    (let (group)
-      (save-excursion
-       (set-buffer (get-buffer-create " *nnmail active*"))
-       (buffer-disable-undo (current-buffer))
-       (erase-buffer)
-       (while group-assoc
-         (setq group (pop group-assoc))
-         (insert (format "%s %d %d y\n" (car group) (cdadr group) 
-                         (caadr group))))
-       (unless (file-exists-p (file-name-directory file-name))
-         (make-directory (file-name-directory file-name) t))
-       (nnmail-write-region
-        1 (point-max) (expand-file-name file-name) nil 'nomesg)
-       (kill-buffer (current-buffer))))))
+    (nnheader-temp-write file-name
+      (nnmail-generate-active group-assoc))))
+
+(defun nnmail-generate-active (alist)
+  "Generate an active file from group-alist ALIST."
+  (erase-buffer)
+  (let (group)
+    (while (setq group (pop alist))
+      (insert (format "%s %d %d y\n" (car group) (cdadr group) 
+                     (caadr group))))))
 
 (defun nnmail-get-split-group (file group)
+  "Find out whether this FILE is to be split into GROUP only.
+If GROUP is non-nil and we are using procmail, return the group name
+only when the file is the correct procmail file.  When GROUP is nil,
+return nil if FILE is a spool file or the procmail group for which it
+is a spool.  If not using procmail, return GROUP."
   (if (or (eq nnmail-spool-file 'procmail)
          nnmail-use-procmail)
-      (cond (group group)
-           ((string-match (concat "^" (expand-file-name
-                                       (file-name-as-directory
-                                        nnmail-procmail-directory))
-                                  "\\([^/]*\\)" nnmail-procmail-suffix "$")
-                          (expand-file-name file))
-            (substring (expand-file-name file)
-                       (match-beginning 1) (match-end 1)))
-           (t
-            group))
+      (if (string-match (concat "^" (expand-file-name
+                                    (file-name-as-directory
+                                     nnmail-procmail-directory))
+                               "\\([^/]*\\)" nnmail-procmail-suffix "$")
+                       (expand-file-name file))
+         (let ((procmail-group (substring (expand-file-name file)
+                                          (match-beginning 1)
+                                          (match-end 1))))
+           (if group 
+               (if (string-equal group procmail-group)
+                   group
+                 nil)
+             procmail-group))
+       nil)
     group))
 
 (defun nnmail-process-babyl-mail-format (func artnum-func)
@@ -527,11 +558,16 @@ nn*-request-list should have been called before calling this function."
        "\f\n0, *unseen,+\n\\(\\*\\*\\* EOOH \\*\\*\\*\n\\)?" nil t)
       (goto-char (match-end 0))
       (delete-region (match-beginning 0) (match-end 0))
-      (setq start (point))
-      ;; Skip all the headers in case there are more "From "s...
-      (or (search-forward "\n\n" nil t)
-         (search-forward-regexp "^[^:]*\\( .*\\|\\)$" nil t)
-         (search-forward "\1f\f"))
+      (narrow-to-region
+       (setq start (point))
+       (progn
+        ;; Skip all the headers in case there are more "From "s...
+        (or (search-forward "\n\n" nil t)
+            (search-forward-regexp "^[^:]*\\( .*\\|\\)$" nil t)
+            (search-forward "\1f\f"))
+        (point)))
+      (run-hooks 'nnmail-prepare-incoming-header-hook)
+      (widen)
       ;; Find the Message-ID header.
       (save-excursion
        (if (re-search-backward "^Message-ID:[ \t]*\\(<[^>]*>\\)" nil t)
@@ -569,10 +605,10 @@ nn*-request-list should have been called before calling this function."
          (setq do-search t)))
       ;; Go to the beginning of the next article - or to the end
       ;; of the buffer.  
-      (if do-search
-         (if (re-search-forward "^\1f" nil t)
-             (goto-char (match-beginning 0))
-           (goto-char (1- (point-max)))))
+      (when do-search
+       (if (re-search-forward "^\1f" nil t)
+           (goto-char (match-beginning 0))
+         (goto-char (1- (point-max)))))
       (delete-char 1)                  ; delete ^_
       (save-excursion
        (save-restriction
@@ -643,6 +679,7 @@ nn*-request-list should have been called before calling this function."
          ;; having a (possibly) faulty header.
          (beginning-of-line)
          (insert "X-"))
+       (run-hooks 'nnmail-prepare-incoming-header-hook)
        ;; Find the end of this article.
        (goto-char (point-max))
        (widen)
@@ -716,6 +753,7 @@ nn*-request-list should have been called before calling this function."
              (insert "Original-")))
          (forward-line 1)
          (insert "Message-ID: " (setq message-id (nnmail-message-id)) "\n"))
+       (run-hooks 'nnmail-prepare-incoming-header-hook)
        ;; Find the end of this article.
        (goto-char (point-max))
        (widen)
@@ -870,6 +908,31 @@ Return the number of characters in the body."
        (setq group-alist (cdr group-alist)))
       (insert "\n"))))
 
+;;; Message washing functions
+
+(defun nnmail-remove-leading-whitespace ()
+  "Remove excessive whitespace from all headers."
+  (goto-char (point-min))
+  (while (re-search-forward "^\\([^ :]+: \\) +" nil t)
+    (replace-match "\\1" t t)))
+
+(defun nnmail-remove-list-identifiers ()
+  "Remove list identifiers from Subject headers."
+  (let ((regexp (if (stringp nnmail-list-identifiers) nnmail-list-identifiers
+                 (mapconcat 'identity nnmail-list-identifiers "\\|"))))
+    (when regexp
+      (goto-char (point-min))
+      (when (re-search-forward
+            (concat "Subject: +\\(Re: +\\)?\\(" regexp "\\) *")
+            nil t)
+       (delete-region (match-beginning 2) (match-end 0))))))
+
+(defun nnmail-remove-tabs ()
+  "Translate TAB characters into SPACE characters."
+  (subst-char-in-region (point-min) (point-max) ?\t ?  t))
+
+;;; Utility functions
+
 ;; Written by byer@mv.us.adobe.com (Scott Byer).
 (defun nnmail-make-complex-temp-name (prefix)
   (let ((newname (make-temp-name prefix))
@@ -955,7 +1018,7 @@ See the documentation for the variable `nnmail-split-fancy' for documentation."
                             (> (nnheader-file-size
                                 (file-truename nnmail-crash-box)) 0))
                    (list nnmail-crash-box))))
-      ;; Remove any directories that inadvertantly match the procmail
+      ;; Remove any directories that inadvertently match the procmail
       ;; suffix, which might happen if the suffix is "". 
       (while p
        (when (file-directory-p (car p))
@@ -1077,8 +1140,10 @@ See the documentation for the variable `nnmail-split-fancy' for documentation."
       (search-backward id nil t))))
 
 (defun nnmail-check-duplication (message-id func artnum-func)
+  (run-hooks 'nnmail-prepare-incoming-message-hook)
   ;; If this is a duplicate message, then we do not save it.
   (let* ((duplication (nnmail-cache-id-exists-p message-id))
+        (case-fold-search t)
         (action (when duplication
                   (cond
                    ((memq nnmail-treat-duplicates '(warn delete))
@@ -1087,15 +1152,15 @@ See the documentation for the variable `nnmail-split-fancy' for documentation."
                     (funcall nnmail-treat-duplicates message-id))
                    (t
                     nnmail-treat-duplicates))))
-        (group-art (nreverse (nnmail-article-group artnum-func))))
+        group-art)
+    ;; Let the backend save the article (or not).
     (cond
-     ((null group-art)
-      (delete-region (point-min) (point-max)))
      ((not duplication)
       (nnmail-cache-insert message-id)
-      (funcall func group-art))
+      (funcall func (setq group-art
+                         (nreverse (nnmail-article-group artnum-func)))))
      ((eq action 'delete)
-      (delete-region (point-min) (point-max)))
+      (setq group-art nil))
      ((eq action 'warn)
       ;; We insert a warning.
       (let ((case-fold-search t)
@@ -1109,9 +1174,15 @@ See the documentation for the variable `nnmail-split-fancy' for documentation."
         "Message-ID: " newid "\n"
         "Gnus-Warning: This is a duplicate of message " message-id "\n")
        (nnmail-cache-insert newid)
-       (funcall func group-art)))
+       (funcall func (setq group-art
+                           (nreverse (nnmail-article-group artnum-func))))))
      (t
-      (funcall func group-art)))))
+      (funcall func (setq group-art
+                         (nreverse (nnmail-article-group artnum-func))))))
+    ;; Add the group-art list to the history list.
+    (if group-art
+       (push group-art nnmail-split-history)
+      (delete-region (point-min) (point-max)))))
 
 ;;; Get new mail.
 
@@ -1123,6 +1194,8 @@ See the documentation for the variable `nnmail-split-fancy' for documentation."
 (defun nnmail-get-new-mail (method exit-func temp
                                   &optional group spool-func)
   "Read new incoming mail."
+  ;; Nix out the previous split history.
+  (setq nnmail-split-history nil)
   (let* ((spools (nnmail-get-spool-files group))
         (group-in group)
         incoming incomings spool)
@@ -1140,7 +1213,7 @@ See the documentation for the variable `nnmail-split-fancy' for documentation."
        (setq spool (pop spools))
        ;; We read each spool file if either the spool is a POP-mail
        ;; spool, or the file exists.  We can't check for the
-       ;; existance of POPped mail.
+       ;; existence of POPped mail.
        (when (or (string-match "^po:" spool)
                  (and (file-exists-p spool)
                       (> (nnheader-file-size (file-truename spool)) 0)))
@@ -1223,7 +1296,7 @@ See the documentation for the variable `nnmail-split-fancy' for documentation."
   (save-restriction
     (message-narrow-to-head)
     (let ((case-fold-search t))
-      (unless (re-search-forward "^Message-Id:" nil t)
+      (unless (re-search-forward "^Message-ID:" nil t)
        (insert "Message-ID: " (nnmail-message-id) "\n")))))
 
 (defun nnmail-write-region (start end filename &optional append visit lockname)
@@ -1290,6 +1363,24 @@ See the documentation for the variable `nnmail-split-fancy' for documentation."
        (cdr elem))))
    status " "))
 
+(defun nnmail-split-history ()
+  "Generate an overview of where the last mail split put articles."
+  (interactive)
+  (unless nnmail-split-history
+    (error "No current split history"))
+  (pop-to-buffer "*nnmail split history*")
+  (buffer-disable-undo (current-buffer))
+  (erase-buffer)
+  (let ((history nnmail-split-history)
+       elem ga)
+    (while (setq elem (pop history))
+      (insert (mapconcat (lambda (ga)
+                          (concat (car ga) ":" (int-to-string (cdr ga))))
+                        elem
+                        ", ")
+             "\n"))
+    (goto-char (point-min))))
+       
 (run-hooks 'nnmail-load-hook)
            
 (provide 'nnmail)