Move compiler macros to gnus-clfns.el; load gnus-clfns.el.
[elisp/gnus.git-] / lisp / pop3.el
index 42a5f5b..24ea4e5 100644 (file)
@@ -35,8 +35,9 @@
 
 ;;; Code:
 
+(eval-when-compile (require 'cl))
+
 (require 'mail-utils)
-(provide 'pop3)
 
 (defconst pop3-version "1.3s")
 
@@ -64,8 +65,7 @@ values are 'apop.")
 Used for APOP authentication.")
 
 (defvar pop3-leave-mail-on-server nil
-  "Non-nil if mail is to be left on the server and UIDL used for 
-message retrieval.")
+  "Non-nil if mail is to be left on the server and UIDL used for message retrieval.")
 
 (defvar pop3-maximum-message-size nil
   "If non-nil only download messages smaller than this.")
@@ -87,12 +87,17 @@ Nil means no, t means yes, not-nil-or-t means yet to be determined.")
 (defvar pop3-debug nil)
 
 (eval-and-compile
-  (autoload 'open-ssl-stream "ssl"))
+  (autoload 'open-ssl-stream "ssl")
+  (autoload 'starttls-open-stream "starttls")
+  (autoload 'starttls-negotiate "starttls"))
 
 (defvar pop3-ssl-program-arguments
-  '("-quiet")
+  '("s_client" "-quiet")
   "Arguments to be passed to the program `pop3-ssl-program-name'.")
 
+(defun pop3-progress-message (format percent &rest args)
+  (apply (function message) format args))
+
 (defun pop3-movemail (&optional crashbox)
   "Transfer contents of a maildrop to the specified CRASHBOX."
   (or crashbox (setq crashbox (expand-file-name "~/.crashbox")))
@@ -100,8 +105,8 @@ Nil means no, t means yes, not-nil-or-t means yet to be determined.")
         (crashbuf (get-buffer-create " *pop3-retr*"))
         (n 1)
         (pop3-password pop3-password)
-        (pop3-uidl-file-name 
-         (convert-standard-filename 
+        (pop3-uidl-file-name
+         (convert-standard-filename
           (concat pop3-uidl-file-name "-" pop3-mailhost)))
         (retrieved-messages nil)
         messages message-count)
@@ -116,19 +121,20 @@ Nil means no, t means yes, not-nil-or-t means yet to be determined.")
          ((equal 'pass pop3-authentication-scheme)
           (pop3-user process pop3-maildrop)
           (pop3-pass process))
-         (t (error "Invalid POP3 authentication scheme.")))
+         (t (error "Invalid POP3 authentication scheme")))
     ;; get messages that are suitable for download
     (message "Retrieving message list...")
     (setq messages (pop3-get-message-numbers process)
          message-count (length (cdr messages)))
-    (message (format "Retrieving message list...%d of %d unread" 
+    (message (format "Retrieving message list...%d of %d unread"
                     message-count (pop messages)))
     (unwind-protect
-       (unless (stringp crashbox)
+       (unless (not (stringp crashbox))
          (while messages
-           (message 
-            (format "Retrieving message %d of %d (%d octets) from %s..."
-                    n message-count (cdar messages) pop3-mailhost))
+           (pop3-progress-message
+            "Retrieving message %d of %d (%d octets) from %s..."
+            (floor (* (/ (float n) message-count) 100))
+            n message-count (cdar messages) pop3-mailhost)
            (pop3-retr process (caar messages) crashbuf)
            (push (caar messages) retrieved-messages)
            (setq messages (cdr messages)
@@ -150,9 +156,32 @@ Nil means no, t means yes, not-nil-or-t means yet to be determined.")
     (kill-buffer crashbuf)
     message-count))
 
+(defun pop3-get-message-count ()
+  "Return the number of messages in the maildrop."
+  (let* ((process (pop3-open-server pop3-mailhost pop3-port))
+        message-count
+        (pop3-password pop3-password)
+        )
+    ;; for debugging only
+    (if pop3-debug (switch-to-buffer (process-buffer process)))
+    ;; query for password
+    (if (and pop3-password-required (not pop3-password))
+       (setq pop3-password
+             (pop3-read-passwd (format "Password for %s: " pop3-maildrop))))
+    (cond ((equal 'apop pop3-authentication-scheme)
+          (pop3-apop process pop3-maildrop))
+         ((equal 'pass pop3-authentication-scheme)
+          (pop3-user process pop3-maildrop)
+          (pop3-pass process))
+         (t (error "Invalid POP3 authentication scheme.")))
+    (setq message-count (car (pop3-stat process)))
+    (pop3-quit process)
+    message-count))
+
 (defun pop3-open-server (mailhost port)
   "Open TCP connection to MAILHOST.
-Returns the process associated with the connection."
+Returns the process associated with the connection.
+Argument PORT specifies connecting port."
   (let ((process-buffer
         (get-buffer-create (format "trace of POP session to %s" mailhost)))
        (process))
@@ -164,6 +193,8 @@ Returns the process associated with the connection."
      (cond
       ((eq pop3-connection-type 'ssl)
        (pop3-open-ssl-stream "POP" process-buffer mailhost port))
+      ((eq pop3-connection-type 'tls)
+       (pop3-open-tls-stream "POP" process-buffer mailhost port))
       (t
        (open-network-stream-as-binary "POP" process-buffer mailhost port))))
     (setq pop3-read-point (point-min))
@@ -174,7 +205,13 @@ Returns the process associated with the connection."
     process))
 
 (defun pop3-open-ssl-stream-1 (name buffer host service extra-arg)
-  (let* ((ssl-program-arguments 
+  (require 'path-util)
+  (let* ((ssl-program-name
+         (cond ((exec-installed-p "openssl")
+                "openssl")
+               (t
+                "ssleay")))
+        (ssl-program-arguments
          `(,@pop3-ssl-program-arguments ,extra-arg
            "-connect" ,(format "%s:%d" host service)))
          (process (open-ssl-stream name buffer host service)))
@@ -192,10 +229,30 @@ Returns the process associated with the connection."
           process))))
 
 (defun pop3-open-ssl-stream (name buffer host service)
-  "Open a SSL connection for a service to a host."
-  (as-binary-process
-   (or (pop3-open-ssl-stream-1 name buffer host service "-ssl3")
-       (pop3-open-ssl-stream-1 name buffer host service "-ssl2"))))
+  "Open a SSL connection for a service to a host.
+Returns a subprocess-object to represent the connection.
+Args are NAME BUFFER HOST SERVICE."
+  (cond ((eq system-type 'windows-nt)
+        (let (selective-display
+              (coding-system-for-write 'binary)
+              (coding-system-for-read 'raw-text-dos))
+          (or (pop3-open-ssl-stream-1 name buffer host service "-ssl3")
+              (pop3-open-ssl-stream-1 name buffer host service "-ssl2"))))
+       (t
+        (as-binary-process
+          (or (pop3-open-ssl-stream-1 name buffer host service "-ssl3")
+              (pop3-open-ssl-stream-1 name buffer host service "-ssl2"))))))
+
+(defun pop3-open-tls-stream (name buffer host service)
+  "Open a TLSv1 connection for a service to a host.
+Returns a subprocess-object to represent the connection.
+Args are NAME BUFFER HOST SERVICE."
+  (let ((process
+        (as-binary-process (starttls-open-stream
+                            name buffer host service))))
+    (pop3-stls process)
+    (starttls-negotiate process)
+    process))
 
 ;; Support functions
 
@@ -206,19 +263,19 @@ Returns the process associated with the connection."
     (insert output)))
 
 (defun pop3-send-command (process command)
-    (set-buffer (process-buffer process))
-    (goto-char (point-max))
-;;    (if (= (aref command 0) ?P)
-;;     (insert "PASS <omitted>\r\n")
-;;      (insert command "\r\n"))
-    (setq pop3-read-point (point))
-    (goto-char (point-max))
-    (process-send-string process (concat command "\r\n"))
-    )
+  (set-buffer (process-buffer process))
+  (goto-char (point-max))
+  ;;    (if (= (aref command 0) ?P)
+  ;;   (insert "PASS <omitted>\r\n")
+  ;;      (insert command "\r\n"))
+  (setq pop3-read-point (point))
+  (goto-char (point-max))
+  (process-send-string process (concat command "\r\n"))
+  )
 
 (defun pop3-read-response (process &optional return)
-  "Read the response from the server.
-Return the response string if optional second argument is non-nil."
+  "Read the response from the server PROCESS.
+Return the response string if optional second argument RETURN is non-nil."
   (let ((case-fold-search nil)
        match-end)
     (save-excursion
@@ -363,23 +420,23 @@ Return the response string if optional second argument is non-nil."
 
 (defun pop3-save-uidls ()
   "Save the updated UIDLs to disk for use next time."
-  (when (and pop3-leave-mail-on-server 
-            pop3-uidl-obarray
-            (catch 'found
-              (dotimes (i (length pop3-uidl-obarray))
-                (if (symbolp (aref pop3-uidl-obarray i))
-                    (throw 'found t)))))
+  (when (and pop3-leave-mail-on-server
+            ;; UIDL hash table is non-empty
+            (let ((len (length pop3-uidl-obarray)))
+              (while (< 0 len)
+                (setq len (if (symbolp (aref pop3-uidl-obarray (1- len)))
+                              -1 (1- len))))
+              (minusp len)))
     (when (file-readable-p pop3-uidl-file-name)
       (copy-file pop3-uidl-file-name
                 (concat pop3-uidl-file-name ".old")
                 'overwrite 'keeptime))
     (save-excursion
       (with-temp-file pop3-uidl-file-name
-        (mapatoms 
+       (mapatoms
         (lambda (atom)
           (when (car (symbol-value atom))
-            (insert (format "%s\n" atom))
-            (unintern atom pop3-uidl-obarray)))
+            (insert (format "%s\n" atom))))
         pop3-uidl-obarray)))))
     
 
@@ -401,15 +458,23 @@ Return the response string if optional second argument is non-nil."
     (if (not (and response (string-match "+OK" response)))
        (pop3-quit process))))
 
+(autoload 'md5 "md5")
+
 (defun pop3-apop (process user)
   "Send alternate authentication information to the server."
-  (if (not (fboundp 'md5)) (autoload 'md5 "md5"))
   (let ((hash (md5 (concat pop3-timestamp pop3-password))))
     (pop3-send-command process (format "APOP %s %s" user hash))
     (let ((response (pop3-read-response process t)))
       (if (not (and response (string-match "+OK" response)))
          (pop3-quit process)))))
 
+(defun pop3-stls (process)
+  "Query whether TLS extension is supported"
+  (pop3-send-command process "STLS")
+  (let ((response (pop3-read-response process t)))
+    (if (not (and response (string-match "+OK" response)))
+       (pop3-quit process))))
+
 ;; TRANSACTION STATE
 
 (defun pop3-stat (process)
@@ -466,7 +531,13 @@ and close the connection."
       (set-buffer (process-buffer process))
       (goto-char (point-max))
       (delete-process process)
-      )))
+      ))
+  (when pop3-leave-mail-on-server
+    (mapatoms
+     (lambda (atom)
+       (when (car (symbol-value atom))
+        (unintern atom pop3-uidl-obarray)))
+     pop3-uidl-obarray)))
 
 (defun pop3-uidl (process &optional msgno)
   "Return the results of a UIDL command in PROCESS for optional MSGNO.
@@ -581,6 +652,13 @@ If msgno is invalid, return nil.  Otherwise, return a string."
 ;;  -ERR [invalid password]
 ;;  -ERR [unable to lock maildrop]
 
+;; STLS
+;; Arguments: none
+;; Restrictions: authorization state
+;; Possible responses:
+;;  +OK [negotiation is ready]
+;;  -ERR [security layer is already active]
+
 ;;; TRANSACTION STATE
 
 ;; STAT
@@ -649,3 +727,7 @@ If msgno is invalid, return nil.  Otherwise, return a string."
 ;; Restrictions: none
 ;; Possible responses:
 ;;  +OK [TCP connection closed]
+
+(provide 'pop3)
+
+;;; pop3.el ends here