This commit was generated by cvs2svn to compensate for changes in r2264,
[elisp/gnus.git-] / lisp / mail-source.el
index f7d1b83..4d9c958 100644 (file)
 (eval-when-compile (require 'cl))
 (eval-and-compile
   (autoload 'pop3-movemail "pop3"))
+(require 'format-spec)
 
 (defgroup mail-source nil
   "The mail-fetching library."
   :group 'gnus)
 
-(defcustom mail-source-movemail-program "movemail"
-  "*A command to be executed to move mail from the inbox.
-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."
-  :group 'mail-source
-  :type '(choice string
-                function))
-
-(defcustom mail-source-movemail-args nil
-  "*Extra arguments to give to `mail-source-movemail-program'  to move mail from the inbox.
-The default is nil."
-  :group 'mail-source
-  :type '(choice string
-                (constant nil)))
-
 (defcustom mail-source-crash-box "~/.emacs-mail-crash-box"
   "File where mail will be stored while processing it."
   :group 'mail-source
@@ -73,6 +56,9 @@ The default is nil."
 
 ;;; Internal variables.
 
+(defvar mail-source-string ""
+  "A dynamically bound string that says what the current mail source is.")
+
 (eval-and-compile
   (defvar mail-source-keyword-map
     '((file
@@ -81,14 +67,19 @@ The default is nil."
       (directory
        (:path)
        (:suffix ".spool")
-       (:match))
+       (:predicate identity))
       (pop
+       (:prescript)
+       (:postscript)
        (:server (getenv "MAILHOST"))
-       (:port "pop3")
+       (:port "pop")
        (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
-       (:password))
+       (:program)
+       (:function)
+       (:password)
+       (:authentication password))
       (maildir
-       (:path)))
+       (:path "~/Maildir/new/")))
     "Mapping from keywords to default values.
 All keywords that can be used must be listed here."))
 
@@ -96,7 +87,7 @@ All keywords that can be used must be listed here."))
   '((file mail-source-fetch-file)
     (directory mail-source-fetch-directory)
     (pop mail-source-fetch-pop)
-    (qmail mail-source-fetch-qmail))
+    (maildir mail-source-fetch-maildir))
   "A mapping from source type to fetcher function.")
 
 (defvar mail-source-password-cache nil)
@@ -108,7 +99,7 @@ All keywords that can be used must be listed here."))
   "Strip the leading colon off the KEYWORD."
   (intern (substring (symbol-name keyword) 1))))
 
-(eval-when-compile
+(eval-and-compile
   (defun mail-source-bind-1 (type)
     (let* ((defaults (cdr (assq type mail-source-keyword-map)))
           default bind)
@@ -118,14 +109,20 @@ All keywords that can be used must be listed here."))
              bind))
       bind)))
 
-(defmacro mail-source-bind (type source &rest body)
-  "Bind all variables in SOURCE."
-  `(let ,(mail-source-bind-1 type)
-     (mail-source-set-1 source)
+(defmacro mail-source-bind (type-source &rest body)
+  "Return a `let' form that binds all variables in source TYPE.
+At run time, the mail source specifier SOURCE will be inspected,
+and the variables will be set according to it.  Variables not
+specified will be given default values.
+
+After this is done, BODY will be executed in the scope
+of the `let' form."
+  `(let ,(mail-source-bind-1 (car type-source))
+     (mail-source-set-1 ,(cadr type-source))
      ,@body))
 
-(put 'mail-source-bind 'lisp-indent-function 2)
-(put 'mail-source-bind 'edebug-form-spec '(form form body))
+(put 'mail-source-bind 'lisp-indent-function 1)
+(put 'mail-source-bind 'edebug-form-spec '(form body))
 
 (defun mail-source-set-1 (source)
   (let* ((type (pop source))
@@ -147,10 +144,6 @@ All keywords that can be used must be listed here."))
    ((and (listp value)
         (functionp (car value)))
     (eval value))
-   ;; Variable
-   ((and (symbolp value)
-        (boundp value))
-    (symbol-value value))
    ;; Just return the value.
    (t
     value)))
@@ -160,16 +153,17 @@ All keywords that can be used must be listed here."))
 CALLBACK will be called with the name of the file where (some of)
 the mail from SOURCE is put.
 Return the number of files that were found."
-  (let ((function (cadr (assq (car source) mail-source-fetcher-alist)))
-       (found 0))
-    (unless function
-      (error "%S is an invalid mail source specification" source))
-    ;; If there's anything in the crash box, we do it first.
-    (when (file-exists-p mail-source-crash-box)
-      (message "Processing mail from %s..." mail-source-crash-box)
-      (setq found (mail-source-callback
-                  callback mail-source-crash-box)))
-    (+ found (funcall function source callback))))
+  (save-excursion
+    (let ((function (cadr (assq (car source) mail-source-fetcher-alist)))
+         (found 0))
+      (unless function
+       (error "%S is an invalid mail source specification" source))
+      ;; If there's anything in the crash box, we do it first.
+      (when (file-exists-p mail-source-crash-box)
+       (message "Processing mail from %s..." mail-source-crash-box)
+       (setq found (mail-source-callback
+                    callback mail-source-crash-box)))
+      (+ found (funcall function source callback)))))
 
 (defun mail-source-make-complex-temp-name (prefix)
   (let ((newname (make-temp-name prefix))
@@ -185,18 +179,21 @@ Pass INFO on to CALLBACK."
   (if (or (not (file-exists-p mail-source-crash-box))
          (zerop (nth 7 (file-attributes mail-source-crash-box))))
       (progn
-       (delete-file mail-source-crash-box)
+       (when (file-exists-p mail-source-crash-box)
+         (delete-file mail-source-crash-box))
        0)
     (funcall callback mail-source-crash-box info)
-    (if mail-source-delete-incoming
-       (delete-file mail-source-crash-box)
-      (let ((incoming
-            (mail-source-make-complex-temp-name
-             (expand-file-name
-              "Incoming" mail-source-directory))))
-       (unless (file-exists-p (file-name-directory incoming))
-         (make-directory (file-name-directory incoming) t))
-       (rename-file mail-source-crash-box incoming t)))
+    (when (file-exists-p mail-source-crash-box)
+      ;; Delete or move the incoming mail out of the way.
+      (if mail-source-delete-incoming
+         (delete-file mail-source-crash-box)
+       (let ((incoming
+              (mail-source-make-complex-temp-name
+               (expand-file-name
+                "Incoming" mail-source-directory))))
+         (unless (file-exists-p (file-name-directory incoming))
+           (make-directory (file-name-directory incoming) t))
+         (rename-file mail-source-crash-box incoming t))))
     1))
 
 (defun mail-source-movemail (from to)
@@ -216,6 +213,9 @@ Pass INFO on to CALLBACK."
        ((not (file-exists-p from))
        ;; There is no inbox.
        (setq to nil))
+       ((zerop (nth 7 (file-attributes from)))
+       ;; Empty file.
+       (setq to nil))
        (t
        ;; If getting from mail spool directory, use movemail to move
        ;; rather than just renaming, so as to interlock with the
@@ -223,28 +223,14 @@ Pass INFO on to CALLBACK."
        (unwind-protect
            (save-excursion
              (setq errors (generate-new-buffer " *mail source loss*"))
-             (buffer-disable-undo errors)
-             (if (functionp mail-source-movemail-program)
-                 (condition-case err
-                     (progn
-                       (funcall mail-source-movemail-program from to)
-                       (setq result 0))
-                   (error
-                    (save-excursion
-                      (set-buffer errors)
-                      (insert (prin1-to-string err))
-                      (setq result 255))))
-               (let ((default-directory "/"))
-                 (setq result
-                       (apply
-                        'call-process
-                        (append
-                         (list
-                          (expand-file-name
-                           mail-source-movemail-program exec-directory)
-                          nil errors nil from to)
-                         (when mail-source-movemail-args
-                           mail-source-movemail-args))))))
+             (let ((default-directory "/"))
+               (setq result
+                     (apply
+                      'call-process
+                      (append
+                       (list
+                        (expand-file-name "movemail" exec-directory)
+                        nil errors nil from to)))))
              (when (file-exists-p to)
                (set-file-modes to mail-source-default-file-modes))
              (if (and (not (buffer-modified-p errors))
@@ -270,7 +256,8 @@ Pass INFO on to CALLBACK."
                                   (buffer-string) result))
                    (error "%s" (buffer-string)))
                  (setq to nil)))))))
-      (when (buffer-name errors)
+      (when (and errors
+                (buffer-name errors))
        (kill-buffer errors))
       ;; Return whether we moved successfully or not.
       to)))
@@ -284,55 +271,117 @@ If ARGS, PROMPT is used as an argument to `format'."
             (apply 'format prompt args)
           prompt)))
     (unless mail-source-read-passwd
-      (if (load "passwd" t)
+      (if (or (fboundp 'read-passwd) (load "passwd" t))
          (setq mail-source-read-passwd 'read-passwd)
        (unless (fboundp 'ange-ftp-read-passwd)
          (autoload 'ange-ftp-read-passwd "ange-ftp"))
        (setq mail-source-read-passwd 'ange-ftp-read-passwd)))
     (funcall mail-source-read-passwd prompt)))
 
+(defun mail-source-fetch-with-program (program)
+  (zerop (call-process shell-file-name nil nil nil
+                      shell-command-switch program)))
+
+;;;
+;;; Different fetchers
+;;;
+
 (defun mail-source-fetch-file (source callback)
   "Fetcher for single-file sources."
-  (mail-source-bind file source
-    (if (mail-source-movemail path mail-source-crash-box)
-       (mail-source-callback callback path)
-      0)))
+  (mail-source-bind (file source)
+    (let ((mail-source-string (format "file:%s" path)))
+      (if (mail-source-movemail path mail-source-crash-box)
+         (mail-source-callback callback path)
+       0))))
 
 (defun mail-source-fetch-directory (source callback)
   "Fetcher for directory sources."
-  (mail-source-bind directory source
-    (let ((files (directory-files
-                 path t
-                 (or match (concat (regexp-quote suffix) "$"))))
-         (found 0)
-         file)
-      (while (setq file (pop files))
-       (when (mail-source-movemail file mail-source-crash-box)
+  (mail-source-bind (directory source)
+    (let ((found 0)
+         (mail-source-string (format "directory:%s" path)))
+      (dolist (file (directory-files
+                    path t (concat (regexp-quote suffix) "$")))
+       (when (and (file-regular-p file)
+                  (funcall predicate file)
+                  (mail-source-movemail file mail-source-crash-box))
          (incf found (mail-source-callback callback file))))
       found)))
 
 (defun mail-source-fetch-pop (source callback)
   "Fetcher for single-file sources."
-  (mail-source-bind pop source
-    (let ((from (format "%s:%s:%s" server user port)))
-      (setq password
-           (or password
-               (cdr (assoc from mail-source-password-cache))
-               (mail-source-read-passwd
-                (format "Password for %s at %s: " user server))))
-      (unless (assoc from mail-source-password-cache)
-       (push (cons from password) mail-source-password-cache))
-      (let ((pop3-password password)
-           (pop3-maildrop user)
-           (pop3-mailhost server))
-       (if (pop3-movemail mail-source-crash-box)
+  (mail-source-bind (pop source)
+    (when prescript
+      (if (fboundp prescript)
+         (funcall prescript)
+       (call-process shell-file-name nil nil nil
+                     shell-command-switch 
+                     (format-spec
+                      prescript
+                      (format-spec-make ?p password ?t mail-source-crash-box
+                                        ?s server ?P port ?u user)))))
+    (let ((from (format "%s:%s:%s" server user port))
+         (mail-source-string (format "pop:%s@%s" user server))
+         result)
+      (when (and (not (eq authentication 'apop))
+                (not program))
+       (setq password
+             (or password
+                 (cdr (assoc from mail-source-password-cache))
+                 (mail-source-read-passwd
+                  (format "Password for %s at %s: " user server))))
+       (unless (assoc from mail-source-password-cache)
+         (push (cons from password) mail-source-password-cache)))
+      (when server
+       (setenv "MAILHOST" server))
+      (setq result
+           (cond
+            (program
+             (mail-source-fetch-with-program
+              (format-spec
+               program
+               (format-spec-make ?p password ?t mail-source-crash-box
+                                 ?s server ?P port ?u user))))
+            (function
+             (funcall function mail-source-crash-box))
+            ;; The default is to use pop3.el.
+            (t
+             (let ((pop3-password password)
+                   (pop3-maildrop user)
+                   (pop3-mailhost server)
+                   (pop3-port port)
+                   (pop3-authentication-scheme
+                    (if (eq authentication 'apop) 'apop 'pass)))
+               (save-excursion (pop3-movemail mail-source-crash-box))))))
+      (if result
+         (progn
            (mail-source-callback callback server)
-         ;; We nix out the password in case the error
-         ;; was because of a wrong password being given.
-         (setq mail-source-password-cache
-               (delq (assoc from mail-source-password-cache)
-                     mail-source-password-cache))
-         0)))))
+           (when prescript
+             (if (fboundp prescript)
+                 (funcall prescript)
+               (call-process shell-file-name nil nil nil
+                             shell-command-switch 
+                             (format-spec
+                              postscript
+                              (format-spec-make
+                               ?p password ?t mail-source-crash-box
+                               ?s server ?P port ?u user))))))
+       ;; We nix out the password in case the error
+       ;; was because of a wrong password being given.
+       (setq mail-source-password-cache
+             (delq (assoc from mail-source-password-cache)
+                   mail-source-password-cache))
+       0))))
+
+(defun mail-source-fetch-maildir (source callback)
+  "Fetcher for maildir sources."
+  (mail-source-bind (maildir source)
+    (let ((found 0)
+         (mail-source-string (format "maildir:%s" path)))
+      (dolist (file (directory-files path t))
+       (when (and (file-regular-p file)
+                  (not (rename-file file mail-source-crash-box)))
+         (incf found (mail-source-callback callback file))))
+      found)))
 
 (provide 'mail-source)