Use eval-and-compile to load EIEIO correctly.
[gnus] / lisp / pop3.el
index 3d992cc..08cd7cd 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
@@ -33,6 +32,7 @@
 
 ;;; Code:
 
+(eval-when-compile (require 'cl))
 (require 'mail-utils)
 (defvar parse-time-months)
 
@@ -81,6 +81,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.
 
@@ -128,7 +137,8 @@ Shorter values mean quicker response, but are more CPU intensive.")
                       (truncate pop3-read-timeout))
                    1000))))))
 
-(defun pop3-streaming-movemail (file)
+;;;###autoload
+(defun pop3-movemail (file)
   "Transfer contents of a maildrop to the specified FILE.
 Use streaming commands."
   (let* ((process (pop3-open-server pop3-mailhost pop3-port))
@@ -138,22 +148,23 @@ 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)
        (unless pop3-leave-mail-on-server
          (pop3-send-streaming-command
           process "DELE" message-count nil))))
-    (pop3-quit process)))
+    (pop3-quit process)
+    t))
 
 (defun pop3-send-streaming-command (process command count total-size)
   (erase-buffer)
   (let ((i 1))
-    (while (>= (1+ count) i)
+    (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))
+      (when (zerop (% i pop3-stream-length))
        (pop3-wait-for-messages process i total-size))
       (incf i)))
   (pop3-wait-for-messages process count total-size))
@@ -165,7 +176,7 @@ Use streaming commands."
               (truncate (/ (buffer-size) 1000))
               (truncate (* (/ (* (buffer-size) 1.0)
                               total-size) 100))))
-    (nnheader-accept-process-output process)))
+    (pop3-accept-process-output process)))
 
 (defun pop3-write-to-file (file)
   (let ((pop-buffer (current-buffer))
@@ -203,7 +214,7 @@ Use streaming commands."
   (let ((responses 0))
     (save-excursion
       (goto-char (point-min))
-      (while (or (and (re-search-forward "^\\+OK " nil t)
+      (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))
@@ -225,44 +236,6 @@ Use streaming commands."
           (pop3-pass process))
          (t (error "Invalid POP3 authentication scheme")))))
 
-(defun pop3-movemail (&optional crashbox)
-  "Transfer contents of a maildrop to the specified CRASHBOX."
-  (or crashbox (setq crashbox (expand-file-name "~/.crashbox")))
-  (let* ((process (pop3-open-server pop3-mailhost pop3-port))
-        (crashbuf (get-buffer-create " *pop3-retr*"))
-        (n 1)
-        message-count
-        message-sizes)
-    (pop3-logon process)
-    (setq message-count (car (pop3-stat process)))
-    (when (> message-count 0)
-      (setq message-sizes (pop3-list process)))
-    (unwind-protect
-       (while (<= n message-count)
-         (message "Retrieving message %d of %d from %s... (%.1fk)"
-                  n message-count pop3-mailhost
-                  (/ (cdr (assoc n message-sizes))
-                     1024.0))
-         (pop3-retr process n crashbuf)
-         (save-excursion
-           (set-buffer crashbuf)
-           (let ((coding-system-for-write 'binary))
-             (write-region (point-min) (point-max) crashbox t 'nomesg))
-           (set-buffer (process-buffer process))
-           (erase-buffer))
-          (unless pop3-leave-mail-on-server
-            (pop3-dele process n))
-         (setq n (+ 1 n))
-         (pop3-accept-process-output process))
-      (when (and pop3-leave-mail-on-server
-                (> n 1))
-       (message "pop3.el doesn't support UIDL.  Setting `pop3-leave-mail-on-server'
-to %s might not give the result you'd expect." pop3-leave-mail-on-server)
-       (sit-for 1))
-      (pop3-quit process))
-    (kill-buffer crashbuf))
-  t)
-
 (defun pop3-get-message-count ()
   "Return the number of messages in the maildrop."
   (let* ((process (pop3-open-server pop3-mailhost pop3-port))
@@ -301,15 +274,22 @@ this is nil, `ssl' is assumed for connexions to port
                 (const :tag "SSL/TLS" ssl)
                 (const starttls)))
 
+(eval-and-compile
+  (if (fboundp 'set-process-query-on-exit-flag)
+      (defalias 'pop3-set-process-query-on-exit-flag
+       'set-process-query-on-exit-flag)
+    (defalias 'pop3-set-process-query-on-exit-flag
+      'process-kill-without-query)))
+
 (defun pop3-open-server (mailhost port)
   "Open TCP connection to MAILHOST on PORT.
 Returns the process associated with the connection."
   (let ((coding-system-for-read 'binary)
        (coding-system-for-write 'binary)
        process)
-    (save-excursion
-      (set-buffer (get-buffer-create (concat " trace of POP session to "
-                                            mailhost)))
+    (with-current-buffer
+        (get-buffer-create (concat " trace of POP session to "
+                                   mailhost))
       (erase-buffer)
       (setq pop3-read-point (point-min))
       (setq process
@@ -346,22 +326,23 @@ Returns the process associated with the connection."
              ;; 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))
+             ;; Delay STLS until server greeting is read (Bug#7438).
+             (starttls-open-stream "POP" (current-buffer)
+                                   mailhost (or port 110)))
             (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)))))
-      (set-process-query-on-exit-flag process nil)
+      (when (eq pop3-stream-type 'starttls)
+       (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"))))
+      (pop3-set-process-query-on-exit-flag process nil)
       process)))
 
 ;; Support functions
@@ -381,8 +362,7 @@ Returns the process associated with the connection."
 Return the response string if optional second argument is non-nil."
   (let ((case-fold-search nil)
        match-end)
-    (save-excursion
-      (set-buffer (process-buffer process))
+    (with-current-buffer (process-buffer process)
       (goto-char pop3-read-point)
       (while (and (memq (process-status process) '(open run))
                  (not (search-forward "\r\n" nil t)))
@@ -539,8 +519,7 @@ Otherwise, return the size of the message-id MSG"
     (if msg
        (string-to-number (nth 2 (split-string response " ")))
       (let ((start pop3-read-point) end)
-       (save-excursion
-         (set-buffer (process-buffer process))
+       (with-current-buffer (process-buffer process)
          (while (not (re-search-forward "^\\.\r\n" nil t))
            (pop3-accept-process-output process)
            (goto-char start))
@@ -550,16 +529,14 @@ 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."
   (pop3-send-command process (format "RETR %s" msg))
   (pop3-read-response process)
   (let ((start pop3-read-point) end)
-    (save-excursion
-      (set-buffer (process-buffer process))
+    (with-current-buffer (process-buffer process)
       (while (not (re-search-forward "^\\.\r\n" nil t))
        (pop3-accept-process-output process)
        (goto-char start))
@@ -575,8 +552,7 @@ Otherwise, return the size of the message-id MSG"
       (setq end (point-marker))
       (pop3-clean-region start end)
       (pop3-munge-message-separator start end)
-      (save-excursion
-       (set-buffer crashbuf)
+      (with-current-buffer crashbuf
        (erase-buffer))
       (copy-to-buffer crashbuf start end)
       (delete-region start end)
@@ -613,8 +589,7 @@ and close the connection."
   (pop3-send-command process "QUIT")
   (pop3-read-response process t)
   (if process
-      (save-excursion
-       (set-buffer (process-buffer process))
+      (with-current-buffer (process-buffer process)
        (goto-char (point-max))
        (delete-process process))))
 \f