X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=lisp%2Fpop3.el;h=5f586738f06dfdafa50eb95a76a999cdd53bf0b0;hb=c4389dc3a08287e66ace0a150197369c70296d8e;hp=ec14722a2a36166e02281fa9dd264bf449490726;hpb=6e5fa3553fe8b390e21fcaebf91bfbc8f4bf8447;p=elisp%2Fgnus.git- diff --git a/lisp/pop3.el b/lisp/pop3.el index ec14722..5f58673 100644 --- a/lisp/pop3.el +++ b/lisp/pop3.el @@ -1,10 +1,11 @@ ;;; pop3.el --- Post Office Protocol (RFC 1460) interface -;; Copyright (C) 1996,1997,1998 Free Software Foundation, Inc. +;; Copyright (C) 1996-1999 Free Software Foundation, Inc. ;; Author: Richard L. Pieri +;; Daiki Ueno ;; Keywords: mail, pop3 -;; Version: 1.3m +;; Version: 1.3s ;; This file is part of GNU Emacs. @@ -37,7 +38,7 @@ (require 'mail-utils) (provide 'pop3) -(defconst pop3-version "1.3m") +(defconst pop3-version "1.3s") (defvar pop3-maildrop (or (user-login-name) (getenv "LOGNAME") (getenv "USER") nil) "*POP3 maildrop.") @@ -45,6 +46,8 @@ "*POP3 mailhost.") (defvar pop3-port 110 "*POP3 port.") +(defvar pop3-connection-type nil + "*POP3 connection type.") (defvar pop3-password-required t "*Non-nil if a password is required when connecting to POP server.") @@ -60,18 +63,48 @@ values are 'apop.") "Timestamp returned when initially connected to the POP server. 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.") + +(defvar pop3-maximum-message-size nil + "If non-nil only download messages smaller than this.") + +(defvar pop3-except-header-regexp nil + "If non-nil we do not retrieve messages whose headers are matching this regexp.") + +(defvar pop3-uidl-file-name "~/.uidls" + "File in which to store the UIDL of processed messages.") + +(defvar pop3-uidl-support 'dont-know + "Whether the server supports UIDL. +Nil means no, t means yes, not-nil-or-t means yet to be determined.") + +(defvar pop3-uidl-obarray (make-vector 31 0) + "Uidl hash table.") + (defvar pop3-read-point nil) (defvar pop3-debug nil) +(eval-and-compile + (autoload 'open-ssl-stream "ssl")) + +(defvar pop3-ssl-program-arguments + '("-quiet") + "Arguments to be passed to the program `pop3-ssl-program-name'.") + (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 (pop3-password pop3-password) - ) + (pop3-uidl-file-name + (convert-standard-filename + (concat pop3-uidl-file-name "-" pop3-mailhost))) + (retrieved-messages nil) + messages message-count) ;; for debugging only (if pop3-debug (switch-to-buffer (process-buffer process))) ;; query for password @@ -84,27 +117,38 @@ Used for APOP authentication.") (pop3-user process pop3-maildrop) (pop3-pass process)) (t (error "Invalid POP3 authentication scheme."))) - (setq message-count (car (pop3-stat process))) - (while (<= n message-count) - (message (format "Retrieving message %d of %d from %s..." - n message-count pop3-mailhost)) - (pop3-retr process n crashbuf) - (save-excursion - (set-buffer crashbuf) - (write-region-as-binary (point-min) (point-max) crashbox 'append) - (set-buffer (process-buffer process)) - (while (> (buffer-size) 5000) - (goto-char (point-min)) - (forward-line 50) - (delete-region (point-min) (point)))) - (pop3-dele process n) - (setq n (+ 1 n)) - (if pop3-debug (sit-for 1) (sit-for 0.1)) - ) - (pop3-quit process) + ;; 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-count (pop messages))) + (unwind-protect + (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-retr process (caar messages) crashbuf) + (push (caar messages) retrieved-messages) + (setq messages (cdr messages) + n (1+ n))) + (with-current-buffer crashbuf + (write-region-as-binary (point-min) (point-max) + crashbox 'append 'nomesg)) + ;; mark messages as read + (when pop3-leave-mail-on-server + (pop3-save-uidls)) + ;; now delete the messages we have retrieved + (unless pop3-leave-mail-on-server + (dolist (n retrieved-messages) + (message (format "Deleting message %d of %d from %s..." + n message-count pop3-mailhost)) + (pop3-dele process n))) + ) + (pop3-quit process)) (kill-buffer crashbuf) - ) - ) + message-count)) (defun pop3-open-server (mailhost port) "Open TCP connection to MAILHOST. @@ -114,17 +158,45 @@ Returns the process associated with the connection." (process)) (save-excursion (set-buffer process-buffer) - (erase-buffer) - (setq pop3-read-point (point-min)) - ) - (setq process - (open-network-stream-as-binary "POP" process-buffer mailhost port)) + (erase-buffer)) + (setq + process + (cond + ((eq pop3-connection-type 'ssl) + (pop3-open-ssl-stream "POP" process-buffer mailhost port)) + (t + (open-network-stream-as-binary "POP" process-buffer mailhost port)))) + (setq pop3-read-point (point-min)) (let ((response (pop3-read-response process t))) (setq pop3-timestamp (substring response (or (string-match "<" response) 0) (+ 1 (or (string-match ">" response) -1))))) process)) +(defun pop3-open-ssl-stream-1 (name buffer host service extra-arg) + (let* ((ssl-program-arguments + `(,@pop3-ssl-program-arguments ,extra-arg + "-connect" ,(format "%s:%d" host service))) + (process (open-ssl-stream name buffer host service))) + (when process + (with-current-buffer buffer + (goto-char (point-min)) + (while (and (memq (process-status process) '(open run)) + (goto-char (point-max)) + (forward-line -1) + (not (looking-at "+OK"))) + (accept-process-output process 1) + (sit-for 1)) + (delete-region (point-min) (point))) + (and process (memq (process-status process) '(open run)) + 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")))) + ;; Support functions (defun pop3-process-filter (process output) @@ -141,8 +213,7 @@ Returns the process associated with the connection." ;; (insert command "\r\n")) (setq pop3-read-point (point)) (goto-char (point-max)) - (process-send-string process command) - (process-send-string process "\r\n") + (process-send-string process (concat command "\r\n")) ) (defun pop3-read-response (process &optional return) @@ -186,6 +257,9 @@ Return the response string if optional second argument is non-nil." (while (and (< (point) end) (search-forward "\r\n" end t)) (replace-match "\n" t t)) (goto-char start) + (while (re-search-forward "\n\n\\(From \\)" end t) + (replace-match "\n\n>\\1" t nil)) + (goto-char start) (while (and (< (point) end) (re-search-forward "^\\." end t)) (replace-match "" t t) (forward-char))) @@ -214,7 +288,9 @@ Return the response string if optional second argument is non-nil." (setq date (format-time-string "%a %b %e %T %Y" (if date - (apply 'encode-time (parse-time-string date)) + (condition-case nil + (apply 'encode-time (parse-time-string date)) + (error (current-time))) (current-time)))) (setq From_ (format "\nFrom %s %s\n" from date)) (while (string-match "," From_) @@ -223,6 +299,90 @@ Return the response string if optional second argument is non-nil." (goto-char (point-min)) (insert From_)))))) +;; UIDL support + +(defun pop3-get-message-numbers (process) + "Get the list of message numbers and lengths to retrieve via PROCESS." + ;; we use the LIST comand first anyway to get the message lengths. + ;; then if we're leaving mail on the server, see if the UIDL command + ;; is implemented. if so, we use it to get the message number list. + (let* ((messages (pop3-list process)) + (total (or (pop messages) 0)) + (uidl (if pop3-leave-mail-on-server + (pop3-get-uidl process))) + out) + (while messages + ;; only retrieve messages matching our regexp or in the uidl list + (when (and + ;; remove elements not in the uidl, this assumes the uidl is short + (or (not (eq pop3-uidl-support t)) + (memq (caar messages) uidl)) + (caar messages) + ;; don't download messages that are too large + (not (and pop3-maximum-message-size + (> (cdar messages) pop3-maximum-message-size))) + (not (and pop3-except-header-regexp + (string-match pop3-except-header-regexp + (pop3-top process (caar messages) 0))))) + (push (car messages) out)) + (setq messages (cdr messages))) + (cons total (reverse out)))) + +(defun pop3-get-uidl (process) + "Use PROCESS to get a list of unread message numbers." + (let ((messages (pop3-uidl process)) uidl) + (if (or (null messages) (null pop3-uidl-support)) + (setq pop3-uidl-support nil) + (setq pop3-uidl-support t) + (save-excursion + (with-temp-buffer + (when (file-readable-p pop3-uidl-file-name) + (insert-file-contents pop3-uidl-file-name)) + (goto-char (point-min)) + (while (looking-at "\\([^ \n\t]+\\)") + (set (intern (match-string 1) pop3-uidl-obarray) + (cons nil t)) + (forward-line 1)) + )) + (dolist (message (cdr messages)) + (if (setq uidl (intern-soft (cdr message) pop3-uidl-obarray)) + (setcar (symbol-value uidl) (car message)) + (set (intern (cdr message) pop3-uidl-obarray) + (cons (car message) nil)))) + (pop3-get-unread-message-numbers)) + )) + +(defun pop3-get-unread-message-numbers () + "Return a sorted list of unread msg numbers to retrieve." + (let (nums) + (mapatoms (lambda (atom) + (if (not (cdr (symbol-value atom))) + (push (car (symbol-value atom)) nums))) + pop3-uidl-obarray) + (sort nums '<))) + +(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 (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 + (lambda (atom) + (when (car (symbol-value atom)) + (insert (format "%s\n" atom)) + (unintern atom pop3-uidl-obarray))) + pop3-uidl-obarray))))) + + ;; The Command Set ;; AUTHORIZATION STATE @@ -260,49 +420,15 @@ Return the response string if optional second argument is non-nil." (string-to-int (nth 2 (split-string response)))) )) -(defun pop3-list (process &optional msg) - "Scan listing of available messages. -This function currently does nothing.") - (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)) - (while (not (re-search-forward "^\\.\r\n" nil t)) - (accept-process-output process 3) - ;; bill@att.com ... to save wear and tear on the heap - ;; uncommented because the condensed version below is a problem for - ;; some. - (if (> (buffer-size) 20000) (sleep-for 1)) - (if (> (buffer-size) 50000) (sleep-for 1)) - (if (> (buffer-size) 100000) (sleep-for 1)) - (if (> (buffer-size) 200000) (sleep-for 1)) - (if (> (buffer-size) 500000) (sleep-for 1)) - ;; bill@att.com - ;; condensed into: - ;; (sometimes causes problems for really large messages.) -; (if (> (buffer-size) 20000) (sleep-for (/ (buffer-size) 20000))) - (goto-char start)) - (setq pop3-read-point (point-marker)) -;; this code does not seem to work for some POP servers... -;; and I cannot figure out why not. -; (goto-char (match-beginning 0)) -; (backward-char 2) -; (if (not (looking-at "\r\n")) -; (insert "\r\n")) -; (re-search-forward "\\.\r\n") - (goto-char (match-beginning 0)) - (setq end (point-marker)) - (pop3-clean-region start end) - (pop3-munge-message-separator start end) - (save-excursion - (set-buffer crashbuf) - (erase-buffer)) - (copy-to-buffer crashbuf start end) - (delete-region start end) + (save-excursion + (let ((region (pop3-get-extended-response process))) + (pop3-munge-message-separator (car region) (cadr region)) + (append-to-buffer crashbuf (car region) (cadr region)) + (delete-region (car region) (cadr region)) ))) (defun pop3-dele (process msg) @@ -335,11 +461,100 @@ Tell server to remove all messages marked as deleted, unlock the maildrop, and close the connection." (pop3-send-command process "QUIT") (pop3-read-response process t) - (if process + (when process + (save-excursion + (set-buffer (process-buffer process)) + (goto-char (point-max)) + (delete-process process) + ))) + +(defun pop3-uidl (process &optional msgno) + "Return the results of a UIDL command in PROCESS for optional MSGNO. +If UIDL is unsupported on this mail server or if msgno is invalid, return nil. +Otherwise, return a list in the form + + (N (1 UIDL-1) (2 UIDL-2) ... (N UIDL-N)) + +where + + N is an integer for the number of UIDLs returned (could be 0) + UIDL-n is a string." + + (if msgno + (pop3-send-command process (format "UIDL %d" msgno)) + (pop3-send-command process "UIDL")) + + (if (null (pop3-read-response process t)) + nil ;; UIDL is not supported on this server + (let (pairs uidl) + (save-excursion + (save-restriction + (apply 'narrow-to-region (pop3-get-extended-response process)) + (goto-char (point-min)) + (while (looking-at "\\([^ \n\t]*\\) \\([^ \n\t]*\\)") + (setq msgno (string-to-int (match-string 1)) + uidl (match-string 2)) + (push (cons msgno uidl) pairs) + (beginning-of-line 2)) + (cons (length pairs) (nreverse pairs)) + ))))) + +(defun pop3-list (process &optional msgno) + "Return the results of a LIST command for PROCESS and optional MSGNO. +If (optional) msgno is invalid, return nil. Otherwise, return a list +in the form + + (N (1 LEN-1) (2 LEN-2) ... (N LEN-N)) + +where + + N is an integer for the number of msg/len pairs (could be 0) + LEN-n is an integer." + (if msgno + (pop3-send-command process (format "LIST %d" msgno)) + (pop3-send-command process "LIST")) + + (if (null (pop3-read-response process t)) + nil ;; MSGNO is not valid number + (let (pairs len) (save-excursion - (set-buffer (process-buffer process)) - (goto-char (point-max)) - (delete-process process)))) + (save-restriction + (apply 'narrow-to-region (pop3-get-extended-response process)) + (goto-char (point-min)) + (while (looking-at "\\([^ \n\t]*\\) \\([^ \n\t]*\\)") + (setq msgno (string-to-int (match-string 1)) + len (string-to-int (match-string 2))) + (push (cons msgno len) pairs) + (beginning-of-line 2)) + (cons (length pairs) (nreverse pairs)) + ))))) + +(defun pop3-top (process msgno &optional lines) + "Return the top LINES of messages for PROCESS and MSGNO. +If msgno is invalid, return nil. Otherwise, return a string." + (pop3-send-command process (format "TOP %d %d" msgno (or lines 1))) + (if (pop3-read-response process t) + nil ;; MSGNO is not valid number + (save-excursion + (apply 'buffer-substring (pop3-get-extended-response process))) + )) + +;;; Utility code + +(defun pop3-get-extended-response (process) + "Get the extended pop3 response in the PROCESS buffer." + (let ((start pop3-read-point) end) + (set-buffer (process-buffer process)) + (goto-char start) + (while (not (re-search-forward "^\\.\r\n" nil t)) + (accept-process-output process 3) + (goto-char start)) + (setq pop3-read-point (point-marker)) + (goto-char (match-beginning 0)) + (setq end (point-marker)) + (pop3-clean-region start end) + (list start end))) + ;; Summary of POP3 (Post Office Protocol version 3) commands and responses @@ -381,6 +596,20 @@ and close the connection." ;; +OK [scan listing follows] ;; -ERR [no such message] +;; TOP msg [lines] +;; Arguments: a message-id (required), number of lines (optional) +;; Restrictions: transaction state; msg must not be deleted +;; Possible responses: +;; +OK [partial message listing follows] +;; -ERR [no such message] + +;; UIDL [msg] +;; Arguments: a message-id (optional) +;; Restrictions: transaction state; msg must not be deleted +;; Possible responses: +;; +OK [uidl listing follows] +;; -ERR [no such message] + ;; RETR msg ;; Arguments: a message-id (required) ;; Restrictions: transaction state; msg must not be deleted