Spelling fixes.
[gnus] / lisp / pop3.el
index 950cae2..0f7a450 100644 (file)
@@ -1,7 +1,6 @@
 ;;; pop3.el --- Post Office Protocol (RFC 1460) interface
 
-;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
-;;   2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+;; Copyright (C) 1996-2011 Free Software Foundation, Inc.
 
 ;; Author: Richard L. Pieri <ratinox@peorth.gweep.net>
 ;; Maintainer: FSF
 ;;; Code:
 
 (eval-when-compile (require 'cl))
+
+(eval-and-compile
+  ;; In Emacs 24, `open-protocol-stream' is an autoloaded alias for
+  ;; `make-network-stream'.
+  (unless (fboundp 'open-protocol-stream)
+    (require 'proto-stream)))
+
 (require 'mail-utils)
 (defvar parse-time-months)
 
@@ -82,6 +88,15 @@ valid value is 'apop'."
   :version "22.1" ;; Oort Gnus
   :group 'pop3)
 
+(defcustom pop3-stream-length 100
+  "How many messages should be requested at one time.
+The lower the number, the more latency-sensitive the fetching
+will be.  If your pop3 server doesn't support streaming at all,
+set this to 1."
+  :type 'number
+  :version "24.1"
+  :group 'pop3)
+
 (defcustom pop3-leave-mail-on-server nil
   "*Non-nil if the mail is to be left on the POP server after fetching.
 
@@ -140,7 +155,7 @@ Use streaming commands."
       (let ((size (pop3-stat process)))
        (setq message-count (car size)
              message-total-size (cadr size)))
-      (when (plusp message-count)
+      (when (> message-count 0)
        (pop3-send-streaming-command
         process "RETR" message-count message-total-size)
        (pop3-write-to-file file)
@@ -152,23 +167,39 @@ Use streaming commands."
 
 (defun pop3-send-streaming-command (process command count total-size)
   (erase-buffer)
-  (let ((i 1))
+  (let ((i 1)
+       (start-point (point-min))
+       (waited-for 0))
     (while (>= count i)
       (process-send-string process (format "%s %d\r\n" command i))
       ;; Only do 100 messages at a time to avoid pipe stalls.
-      (when (zerop (% i 100))
-       (pop3-wait-for-messages process i total-size))
-      (incf i)))
-  (pop3-wait-for-messages process count total-size))
-
-(defun pop3-wait-for-messages (process count total-size)
-  (while (< (pop3-number-of-responses total-size) count)
+      (when (zerop (% i pop3-stream-length))
+       (setq start-point
+             (pop3-wait-for-messages process pop3-stream-length
+                                     total-size start-point))
+       (incf waited-for pop3-stream-length))
+      (incf i))
+    (pop3-wait-for-messages process (- count waited-for)
+                           total-size start-point)))
+
+(defun pop3-wait-for-messages (process count total-size start-point)
+  (while (> count 0)
+    (goto-char start-point)
+    (while (or (and (re-search-forward "^\\+OK" nil t)
+                   (or (not total-size)
+                       (re-search-forward "^\\.\r?\n" nil t)))
+              (re-search-forward "^-ERR " nil t))
+      (decf count)
+      (setq start-point (point)))
+    (unless (memq (process-status process) '(open run))
+      (error "pop3 process died"))
     (when total-size
       (message "pop3 retrieved %dKB (%d%%)"
               (truncate (/ (buffer-size) 1000))
               (truncate (* (/ (* (buffer-size) 1.0)
                               total-size) 100))))
-    (pop3-accept-process-output process)))
+    (pop3-accept-process-output process))
+  start-point)
 
 (defun pop3-write-to-file (file)
   (let ((pop-buffer (current-buffer))
@@ -202,17 +233,6 @@ Use streaming commands."
          (delete-char 1))
        (write-region (point-min) (point-max) file nil 'nomesg)))))
 
-(defun pop3-number-of-responses (endp)
-  (let ((responses 0))
-    (save-excursion
-      (goto-char (point-min))
-      (while (or (and (re-search-forward "^\\+OK" nil t)
-                     (or (not endp)
-                         (re-search-forward "^\\.\r?\n" nil t)))
-                (re-search-forward "^-ERR " nil t))
-       (incf responses)))
-    responses))
-
 (defun pop3-logon (process)
   (let ((pop3-password pop3-password))
     ;; for debugging only
@@ -249,16 +269,12 @@ Use streaming commands."
     (pop3-quit process)
     message-count))
 
-(autoload 'open-tls-stream "tls")
-(autoload 'starttls-open-stream "starttls")
-(autoload 'starttls-negotiate "starttls") ; avoid warning
-
 (defcustom pop3-stream-type nil
-  "*Transport security type for POP3 connexions.
-This may be either nil (plain connexion), `ssl' (use an
+  "*Transport security type for POP3 connections.
+This may be either nil (plain connection), `ssl' (use an
 SSL/TSL-secured stream) or `starttls' (use the starttls mechanism
 to turn on TLS security after opening the stream).  However, if
-this is nil, `ssl' is assumed for connexions to port
+this is nil, `ssl' is assumed for connections to port
 995 (pop3s)."
   :version "23.1" ;; No Gnus
   :group 'pop3
@@ -278,63 +294,39 @@ this is nil, `ssl' is assumed for connexions to port
 Returns the process associated with the connection."
   (let ((coding-system-for-read 'binary)
        (coding-system-for-write 'binary)
-       process)
+       result)
     (with-current-buffer
         (get-buffer-create (concat " trace of POP session to "
                                    mailhost))
       (erase-buffer)
       (setq pop3-read-point (point-min))
-      (setq process
-           (cond
-            ((or (eq pop3-stream-type 'ssl)
-                 (and (not pop3-stream-type) (member port '(995 "pop3s"))))
-             ;; gnutls-cli, openssl don't accept service names
-             (if (or (equal port "pop3s")
-                     (null port))
-                 (setq port 995))
-             (let ((process (open-tls-stream "POP" (current-buffer)
-                                             mailhost port)))
-               (when process
-                 ;; There's a load of info printed that needs deleting.
-                 (let ((again 't))
-                   ;; repeat until
-                   ;; - either we received the +OK line
-                   ;; - or accept-process-output timed out without getting
-                   ;;   anything
-                   (while (and again
-                               (setq again (memq (process-status process)
-                                                 '(open run))))
-                     (setq again (pop3-accept-process-output process))
-                     (goto-char (point-max))
-                     (forward-line -1)
-                     (cond ((looking-at "\\+OK")
-                            (setq again nil)
-                            (delete-region (point-min) (point)))
-                           ((not again)
-                            (pop3-quit process)
-                            (error "POP SSL connexion failed")))))
-                 process)))
-            ((eq pop3-stream-type 'starttls)
-             ;; gnutls-cli, openssl don't accept service names
-             (if (equal port "pop3")
-                 (setq port 110))
-             (let ((process (starttls-open-stream "POP" (current-buffer)
-                                                  mailhost (or port 110))))
-               (pop3-send-command process "STLS")
-               (let ((response (pop3-read-response process t)))
-                 (if (and response (string-match "+OK" response))
-                     (starttls-negotiate process)
-                   (pop3-quit process)
-                   (error "POP server doesn't support starttls")))
-               process))
-            (t
-             (open-network-stream "POP" (current-buffer) mailhost port))))
-      (let ((response (pop3-read-response process t)))
-       (setq pop3-timestamp
-             (substring response (or (string-match "<" response) 0)
-                        (+ 1 (or (string-match ">" response) -1)))))
-      (pop3-set-process-query-on-exit-flag process nil)
-      process)))
+      (setq result
+           (open-protocol-stream
+            "POP" (current-buffer) mailhost port
+            :type (cond
+                   ((or (eq pop3-stream-type 'ssl)
+                        (and (not pop3-stream-type)
+                             (member port '(995 "pop3s"))))
+                    'tls)
+                   (t
+                    (or pop3-stream-type 'network)))
+            :capability-command "CAPA\r\n"
+            :end-of-command "^\\(-ERR\\|+OK\\).*\n"
+            :end-of-capability "^\\.\r?\n\\|^-ERR"
+            :success "^\\+OK.*\n"
+            :return-list t
+            :starttls-function
+            (lambda (capabilities)
+              (and (string-match "\\bSTLS\\b" capabilities)
+                   "STLS\r\n"))))
+      (when result
+       (let ((response (plist-get (cdr result) :greeting)))
+         (setq pop3-timestamp
+               (substring response (or (string-match "<" response) 0)
+                          (+ 1 (or (string-match ">" response) -1)))))
+       (pop3-set-process-query-on-exit-flag (car result) nil)
+       (erase-buffer)
+       (car result)))))
 
 ;; Support functions
 
@@ -520,8 +512,7 @@ Otherwise, return the size of the message-id MSG"
          (mapcar #'(lambda (s) (let ((split (split-string s " ")))
                                  (cons (string-to-number (nth 0 split))
                                        (string-to-number (nth 1 split)))))
-                 (delete "" (split-string (buffer-substring start end)
-                                          "\r\n"))))))))
+                 (split-string (buffer-substring start end) "\r\n" t)))))))
 
 (defun pop3-retr (process msg crashbuf)
   "Retrieve message-id MSG to buffer CRASHBUF."
@@ -530,6 +521,8 @@ Otherwise, return the size of the message-id MSG"
   (let ((start pop3-read-point) end)
     (with-current-buffer (process-buffer process)
       (while (not (re-search-forward "^\\.\r\n" nil t))
+       (unless (memq (process-status process) '(open run))
+         (error "pop3 server closed the connection"))
        (pop3-accept-process-output process)
        (goto-char start))
       (setq pop3-read-point (point-marker))