1 ;;; elmo-pop3.el -- POP3 Interface for ELMO.
3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
4 ;; Copyright (C) 1999,2000 Kenichi OKADA <okada@opaopa.org>
6 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
7 ;; Kenichi OKADA <okada@opaopa.org>
8 ;; Keywords: mail, net news
10 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
12 ;; This program is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; This program is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
41 (autoload 'md5 "md5"))
43 (defvar elmo-pop3-use-uidl t
44 "*If non-nil, use UIDL.")
46 (defvar elmo-pop3-exists-exactly t)
48 (luna-define-class elmo-pop3-session (elmo-network-session))
51 (defvar elmo-pop3-read-point nil)
52 (defvar elmo-pop3-number-uidl-hash nil) ; number -> uidl
53 (defvar elmo-pop3-uidl-number-hash nil) ; uidl -> number
54 (defvar elmo-pop3-size-hash nil) ; number -> size
55 (defvar elmo-pop3-uidl-done nil)
56 (defvar elmo-pop3-list-done nil)
58 (defvar elmo-pop3-local-variables '(elmo-pop3-read-point
59 elmo-pop3-uidl-number-hash
60 elmo-pop3-number-uidl-hash
65 (luna-define-method elmo-network-close-session ((session elmo-pop3-session))
66 (when (elmo-network-session-process-internal session)
67 (when (memq (process-status
68 (elmo-network-session-process-internal session))
70 (elmo-pop3-send-command (elmo-network-session-process-internal session)
72 (or (elmo-pop3-read-response
73 (elmo-network-session-process-internal session) t)
74 (error "POP error: QUIT failed")))
75 (kill-buffer (process-buffer
76 (elmo-network-session-process-internal session)))
77 (delete-process (elmo-network-session-process-internal session))))
79 (defun elmo-pop3-get-session (spec &optional if-exists)
80 (elmo-network-get-session
83 (elmo-pop3-spec-hostname spec)
84 (elmo-pop3-spec-port spec)
85 (elmo-pop3-spec-username spec)
86 (elmo-pop3-spec-auth spec)
87 (elmo-pop3-spec-stream-type spec)
90 (defun elmo-pop3-send-command (process command &optional no-erase)
91 (with-current-buffer (process-buffer process)
94 (goto-char (point-min))
95 (setq elmo-pop3-read-point (point))
96 (process-send-string process command)
97 (process-send-string process "\r\n")))
99 (defun elmo-pop3-read-response (process &optional not-command)
100 (with-current-buffer (process-buffer process)
101 (let ((case-fold-search nil)
102 (response-string nil)
103 (response-continue t)
106 (while response-continue
107 (goto-char elmo-pop3-read-point)
108 (while (not (re-search-forward "\r?\n" nil t))
109 (accept-process-output process)
110 (goto-char elmo-pop3-read-point))
111 (setq match-end (point))
112 (setq response-string
113 (buffer-substring elmo-pop3-read-point (- match-end 2)))
114 (goto-char elmo-pop3-read-point)
115 (if (looking-at "\\+.*$")
117 (setq response-continue nil)
118 (setq elmo-pop3-read-point match-end)
121 (concat return-value "\n" response-string)
123 (if (looking-at "\\-.*$")
125 (setq response-continue nil)
126 (setq elmo-pop3-read-point match-end)
127 (setq return-value nil))
128 (setq elmo-pop3-read-point match-end)
130 (setq response-continue nil))
133 (concat return-value "\n" response-string)
135 (setq elmo-pop3-read-point match-end)))
138 (defun elmo-pop3-process-filter (process output)
140 (set-buffer (process-buffer process))
141 (goto-char (point-max))
144 (defun elmo-pop3-auth-user (session)
145 (let ((process (elmo-network-session-process-internal session)))
147 (elmo-pop3-send-command
149 (format "user %s" (elmo-network-session-user-internal session)))
150 (or (elmo-pop3-read-response process t)
151 (signal 'elmo-authenticate-error
152 '(elmo-pop-auth-user)))
153 (elmo-pop3-send-command process
157 (elmo-network-session-password-key session))))
158 (or (elmo-pop3-read-response process t)
159 (signal 'elmo-authenticate-error
160 '(elmo-pop-auth-user)))))
162 (defun elmo-pop3-auth-apop (session)
163 (if (string-match "^\+OK .*\\(<[^\>]+>\\)"
164 (elmo-network-session-greeting-internal session))
165 ;; good, APOP ready server
167 (elmo-pop3-send-command
168 (elmo-network-session-process-internal session)
170 (elmo-network-session-user-internal session)
172 (concat (match-string
174 (elmo-network-session-greeting-internal session))
176 (elmo-network-session-password-key session))))))
177 (or (elmo-pop3-read-response
178 (elmo-network-session-process-internal session)
180 (signal 'elmo-authenticate-error
181 '(elmo-pop3-auth-apop))))
182 (signal 'elmo-open-error '(elmo-pop-auth-apop))))
184 (luna-define-method elmo-network-initialize-session-buffer :after
185 ((session elmo-pop3-session) buffer)
186 (with-current-buffer buffer
187 (mapcar 'make-variable-buffer-local elmo-pop3-local-variables)))
189 (luna-define-method elmo-network-initialize-session ((session
191 (let ((process (elmo-network-session-process-internal session))
193 (with-current-buffer (process-buffer process)
194 (set-process-filter process 'elmo-pop3-process-filter)
195 (setq elmo-pop3-read-point (point-min))
196 ;; Skip garbage output from process before greeting.
197 (while (and (memq (process-status process) '(open run))
198 (goto-char (point-max))
200 (not (looking-at "+OK")))
201 (accept-process-output process 1))
202 (setq elmo-pop3-read-point (point))
203 (or (elmo-network-session-set-greeting-internal
205 (elmo-pop3-read-response process t))
206 (signal 'elmo-open-error
207 '(elmo-network-intialize-session)))
208 (when (eq (elmo-network-stream-type-symbol
209 (elmo-network-session-stream-type-internal session))
211 (elmo-pop3-send-command process "stls")
212 (if (string-match "^\+OK"
213 (elmo-pop3-read-response process))
214 (starttls-negotiate process)
215 (signal 'elmo-open-error
216 '(elmo-pop3-starttls-error)))))))
218 (luna-define-method elmo-network-authenticate-session ((session
220 (with-current-buffer (process-buffer
221 (elmo-network-session-process-internal session))
222 (let* ((process (elmo-network-session-process-internal session))
223 (auth (elmo-network-session-auth-internal session))
224 (auth (mapcar '(lambda (mechanism) (upcase (symbol-name mechanism)))
225 (if (listp auth) auth (list auth))))
226 client name step response mechanism
227 sasl-read-passphrase)
228 (or (and (string= "USER" (car auth))
229 (elmo-pop3-auth-user session))
230 (and (string= "APOP" (car auth))
231 (elmo-pop3-auth-apop session))
233 (setq mechanism (sasl-find-mechanism auth))
235 (signal 'elmo-authenticate-error '(elmo-pop3-auth-no-mechanisms)))
239 (elmo-network-session-user-internal session)
241 (elmo-network-session-host-internal session)))
242 ;;; (if elmo-pop3-auth-user-realm
243 ;;; (sasl-client-set-property client 'realm elmo-pop3-auth-user-realm))
244 (setq name (sasl-mechanism-name mechanism))
245 (elmo-network-session-set-auth-internal session
246 (intern (downcase name)))
247 (setq sasl-read-passphrase
251 (elmo-network-session-password-key session)))))
252 (setq step (sasl-next-step client nil))
253 (elmo-pop3-send-command
256 (and (sasl-step-data step)
259 (elmo-base64-encode-string
260 (sasl-step-data step) 'no-line-break))))) ;)
263 (unless (setq response (elmo-pop3-read-response process t))
264 (signal 'elmo-authenticate-error
266 (concat "elmo-pop3-auth-"
268 (if (string-match "^\+OK" response)
269 (if (sasl-next-step client step)
270 (signal 'elmo-authenticate-error
272 (concat "elmo-pop3-auth-"
277 (elmo-base64-decode-string
278 (cadr (split-string response " "))))
279 (setq step (sasl-next-step client step))
280 (elmo-pop3-send-command
282 (if (sasl-step-data step)
283 (elmo-base64-encode-string (sasl-step-data step)
287 (luna-define-method elmo-network-setup-session ((session
289 (let ((process (elmo-network-session-process-internal session))
291 (with-current-buffer (process-buffer process)
292 (setq elmo-pop3-size-hash (elmo-make-hash 31))
293 ;; To get obarray of uidl and size
294 (elmo-pop3-send-command process "list")
295 (if (null (elmo-pop3-read-response process))
296 (error "POP LIST command failed"))
297 (if (null (setq response
298 (elmo-pop3-read-contents
299 (current-buffer) process)))
300 (error "POP LIST command failed"))
301 ;; POP server always returns a sequence of serial numbers.
302 (setq count (elmo-pop3-parse-list-response response))
304 (when elmo-pop3-use-uidl
305 (setq elmo-pop3-uidl-number-hash (elmo-make-hash (* count 2)))
306 (setq elmo-pop3-number-uidl-hash (elmo-make-hash (* count 2)))
308 (elmo-pop3-send-command process "uidl")
309 (unless (elmo-pop3-read-response process)
310 (error "POP UIDL failed"))
311 (unless (setq response (elmo-pop3-read-contents
312 (current-buffer) process))
313 (error "POP UIDL failed"))
314 (elmo-pop3-parse-uidl-response response)))))
316 (defun elmo-pop3-read-contents (buffer process)
319 (let ((case-fold-search nil)
321 (goto-char elmo-pop3-read-point)
322 (while (not (re-search-forward "^\\.\r\n" nil t))
323 (accept-process-output process)
324 (goto-char elmo-pop3-read-point))
325 (setq match-end (point))
327 (buffer-substring elmo-pop3-read-point
331 (defun elmo-pop3-list-folders (spec &optional hierarchy) nil)
332 (defun elmo-pop3-append-msg (spec string) nil nil)
333 (defun elmo-pop3-folder-creatable-p (spec) nil)
334 (defun elmo-pop3-create-folder (spec) nil)
336 (defun elmo-pop3-folder-exists-p (spec)
337 (if (and elmo-pop3-exists-exactly
338 (elmo-pop3-plugged-p spec))
340 (let (elmo-auto-change-plugged ; don't change plug status.
341 elmo-pop3-use-uidl ; No need to use uidl.
344 (setq session (elmo-pop3-get-session spec))
346 (elmo-network-close-session session)))))
349 (defun elmo-pop3-parse-uidl-response (string)
350 (let ((buffer (current-buffer))
353 (let (number uid list)
355 (goto-char (point-min))
356 (while (re-search-forward "^\\([0-9]+\\)[\t ]\\([^ \n]+\\)$" nil t)
357 (setq number (elmo-match-buffer 1))
358 (setq uid (elmo-match-buffer 2))
359 (with-current-buffer buffer
360 (elmo-set-hash-val uid number elmo-pop3-uidl-number-hash)
361 (elmo-set-hash-val (concat "#" number) uid
362 elmo-pop3-number-uidl-hash))
363 (setq list (cons uid list)))
364 (with-current-buffer buffer (setq elmo-pop3-uidl-done t))
367 (defun elmo-pop3-parse-list-response (string)
368 (let ((buffer (current-buffer))
373 (goto-char (point-min))
374 (while (re-search-forward "^\\([0-9]+\\)[\t ]\\([0-9]+\\)$" nil t)
377 (cons (elmo-match-buffer 1)
378 (elmo-match-buffer 2))
380 (setq count (1+ count)))
381 (with-current-buffer buffer
382 (setq elmo-pop3-size-hash (elmo-make-hash (* (length alist) 2)))
384 (elmo-set-hash-val (concat "#" (car (car alist)))
387 (setq alist (cdr alist)))
388 (setq elmo-pop3-list-done t))
391 (defun elmo-pop3-list-location (spec)
392 (with-current-buffer (process-buffer
393 (elmo-network-session-process-internal
394 (elmo-pop3-get-session spec)))
396 (if elmo-pop3-uidl-done
400 (setq list (cons (symbol-name atom) list)))
401 elmo-pop3-uidl-number-hash)
403 (error "POP3: Error in UIDL")))))
405 (defun elmo-pop3-list-by-uidl-subr (spec &optional nonsort)
406 (let ((flist (elmo-list-folder-by-location
408 (elmo-pop3-list-location spec))))
410 (cons (elmo-max-of-list flist) (length flist))
413 (defun elmo-pop3-list-by-list (spec)
414 (with-current-buffer (process-buffer
415 (elmo-network-session-process-internal
416 (elmo-pop3-get-session spec)))
418 (if elmo-pop3-list-done
420 (mapatoms (lambda (atom)
421 (setq list (cons (string-to-int
422 (substring (symbol-name atom) 1))
426 (error "POP3: Error in list")))))
428 (defun elmo-pop3-list-folder (spec)
429 (let ((killed (and elmo-use-killed-list
430 (elmo-msgdb-killed-list-load
431 (elmo-msgdb-expand-path spec))))
433 (elmo-pop3-commit spec)
434 (setq numbers (if elmo-pop3-use-uidl
436 (elmo-pop3-list-by-uidl-subr spec))
437 (elmo-pop3-list-by-list spec)))
438 (elmo-living-messages numbers killed)))
440 (defun elmo-pop3-max-of-folder (spec)
441 (elmo-pop3-commit spec)
442 (if elmo-pop3-use-uidl
443 (elmo-pop3-list-by-uidl-subr spec 'nonsort)
445 (elmo-network-session-process-internal
446 (elmo-pop3-get-session spec)))
449 (with-current-buffer (process-buffer process)
450 (elmo-pop3-send-command process "STAT")
451 (setq response (elmo-pop3-read-response process))
452 ;; response: "^\+OK 2 7570$"
453 (if (not (string-match "^\+OK[ \t]*\\([0-9]*\\)" response))
454 (error "POP STAT command failed")
457 (substring response (match-beginning 1)(match-end 1 ))))
458 (cons total total))))))
460 (defvar elmo-pop3-header-fetch-chop-length 200)
462 (defsubst elmo-pop3-next-result-arrived-p ()
464 ((eq (following-char) ?+)
465 (if (re-search-forward "\n\\.\r?\n" nil t)
469 (if (search-forward "\n" nil t)
475 (defun elmo-pop3-retrieve-headers (buffer tobuffer process articles)
479 (let ((number (length articles))
482 (last-point (point-min)))
483 ;; Send HEAD commands.
485 (elmo-pop3-send-command process (format
486 "top %s 0" (car articles))
488 ;;; (accept-process-output process 1)
489 (setq articles (cdr articles))
490 (setq count (1+ count))
491 ;; Every 200 requests we have to read the stream in
492 ;; order to avoid deadlocks.
493 (when (or elmo-pop3-send-command-synchronously
494 (null articles) ;All requests have been sent.
495 (zerop (% count elmo-pop3-header-fetch-chop-length)))
496 (unless elmo-pop3-send-command-synchronously
497 (accept-process-output process 1))
501 (goto-char last-point)
503 (while (elmo-pop3-next-result-arrived-p)
504 (setq last-point (point))
505 (setq received (1+ received)))
507 (when (> number elmo-display-progress-threshold)
508 (if (or (zerop (% received 5)) (= received number))
509 (elmo-display-progress
510 'elmo-pop3-retrieve-headers "Getting headers..."
511 (/ (* received 100) number))))
512 (accept-process-output process 1)
513 ;;; (accept-process-output process)
515 ;; Remove all "\r"'s.
516 (goto-char (point-min))
517 (while (search-forward "\r\n" nil t)
518 (replace-match "\n"))
519 (copy-to-buffer tobuffer (point-min) (point-max)))))
521 (defalias 'elmo-pop3-msgdb-create 'elmo-pop3-msgdb-create-as-numlist)
523 (defun elmo-pop3-msgdb-create-as-numlist (spec numlist new-mark
524 already-mark seen-mark
525 important-mark seen-list
528 (let ((process (elmo-network-session-process-internal
529 (elmo-pop3-get-session spec)))
531 (if elmo-pop3-use-uidl
532 (setq loc-alist (if msgdb (elmo-msgdb-get-location msgdb)
533 (elmo-msgdb-location-load
534 (elmo-msgdb-expand-path spec)))))
535 (elmo-pop3-msgdb-create-by-header process numlist
536 new-mark already-mark
540 (defun elmo-pop3-uidl-to-number (uidl)
541 (string-to-number (elmo-get-hash-val uidl
542 elmo-pop3-uidl-number-hash)))
544 (defun elmo-pop3-number-to-uidl (number)
545 (elmo-get-hash-val (format "#%d" number)
546 elmo-pop3-number-uidl-hash))
548 (defun elmo-pop3-number-to-size (number)
549 (elmo-get-hash-val (format "#%d" number)
550 elmo-pop3-size-hash))
552 (defun elmo-pop3-msgdb-create-by-header (process numlist
553 new-mark already-mark
557 (let ((tmp-buffer (get-buffer-create " *ELMO Overview TMP*")))
558 (with-current-buffer (process-buffer process)
559 (if loc-alist ; use uidl.
565 (elmo-pop3-uidl-to-number (cdr (assq number loc-alist))))
567 (elmo-pop3-retrieve-headers (process-buffer process)
568 tmp-buffer process numlist)
570 (elmo-pop3-msgdb-create-message
575 new-mark already-mark seen-mark seen-list loc-alist)
576 (kill-buffer tmp-buffer)))))
578 (defun elmo-pop3-msgdb-create-message (buffer
581 numlist new-mark already-mark
586 (let (beg overview number-alist mark-alist
587 entity i number message-id gmark seen size)
589 (elmo-set-buffer-multibyte default-enable-multibyte-characters)
590 (goto-char (point-min))
592 (message "Creating msgdb...")
594 (setq beg (save-excursion (forward-line 1) (point)))
595 (elmo-pop3-next-result-arrived-p)
599 (narrow-to-region beg (point))
601 (elmo-msgdb-create-overview-from-buffer
603 (setq numlist (cdr numlist))
606 (elmo-msgdb-append-element
608 (with-current-buffer (process-buffer process)
609 (elmo-msgdb-overview-entity-set-size
612 (elmo-pop3-number-to-size
613 (elmo-msgdb-overview-entity-get-number entity))))
617 (elmo-pop3-number-to-uidl
618 (elmo-msgdb-overview-entity-get-number entity))
620 (elmo-msgdb-overview-entity-set-number entity number)))
622 (elmo-msgdb-number-add
624 (elmo-msgdb-overview-entity-get-number entity)
626 (setq message-id (car entity))
627 (setq seen (member message-id seen-list))
628 (if (setq gmark (or (elmo-msgdb-global-mark-get message-id)
629 (if (elmo-cache-exists-p
635 (if elmo-pop3-use-cache
639 (elmo-msgdb-mark-append
641 (elmo-msgdb-overview-entity-get-number entity)
643 (when (> num elmo-display-progress-threshold)
645 (if (or (zerop (% i 5)) (= i num))
646 (elmo-display-progress
647 'elmo-pop3-msgdb-create-message "Creating msgdb..."
648 (/ (* i 100) num)))))
649 (list overview number-alist mark-alist loc-alist))))
651 (defun elmo-pop3-read-body (process outbuf)
652 (with-current-buffer (process-buffer process)
653 (let ((start elmo-pop3-read-point)
656 (while (not (re-search-forward "^\\.\r?\n" nil t))
657 (accept-process-output process)
660 (with-current-buffer outbuf
662 (insert-buffer-substring (process-buffer process) start (- end 3))
663 (elmo-delete-cr-get-content-type)))))
665 (defun elmo-pop3-read-msg (spec number outbuf &optional msgdb)
666 (let* ((loc-alist (if elmo-pop3-use-uidl
668 (elmo-msgdb-get-location msgdb)
669 (elmo-msgdb-location-load
670 (elmo-msgdb-expand-path spec)))))
671 (process (elmo-network-session-process-internal
672 (elmo-pop3-get-session spec)))
674 (with-current-buffer (process-buffer process)
676 (setq number (elmo-pop3-uidl-to-number
677 (cdr (assq number loc-alist)))))
679 (elmo-pop3-send-command process
680 (format "retr %s" number))
681 (when (null (setq response (elmo-pop3-read-response
683 (error "Fetching message failed"))
684 (setq response (elmo-pop3-read-body process outbuf))
686 (goto-char (point-min))
687 (while (re-search-forward "^\\." nil t)
692 (defun elmo-pop3-delete-msg (process number loc-alist)
693 (with-current-buffer (process-buffer process)
694 (let (response errmsg msg)
696 (setq number (elmo-pop3-uidl-to-number
697 (cdr (assq number loc-alist)))))
700 (elmo-pop3-send-command process
701 (format "dele %s" number))
702 (when (null (setq response (elmo-pop3-read-response
704 (error "Deleting message failed")))
705 (error "Deleting message failed")))))
707 (defun elmo-pop3-delete-msgs (spec msgs &optional msgdb)
708 (let ((loc-alist (if elmo-pop3-use-uidl
710 (elmo-msgdb-get-location msgdb)
711 (elmo-msgdb-location-load
712 (elmo-msgdb-expand-path spec)))))
713 (process (elmo-network-session-process-internal
714 (elmo-pop3-get-session spec))))
715 (mapcar '(lambda (msg) (elmo-pop3-delete-msg
716 process msg loc-alist))
719 (defun elmo-pop3-search (spec condition &optional numlist)
720 (error "Searching in pop3 folder is not implemented yet"))
722 (defun elmo-pop3-use-cache-p (spec number)
725 (defun elmo-pop3-local-file-p (spec number)
728 (defun elmo-pop3-port-label (spec)
730 (if (elmo-pop3-spec-stream-type spec)
731 (concat "!" (symbol-name
732 (elmo-network-stream-type-symbol
733 (elmo-pop3-spec-stream-type spec)))))))
735 (defsubst elmo-pop3-portinfo (spec)
736 (list (elmo-pop3-spec-hostname spec)
737 (elmo-pop3-spec-port spec)))
739 (defun elmo-pop3-plugged-p (spec)
740 (apply 'elmo-plugged-p
741 (append (elmo-pop3-portinfo spec)
742 (list nil (quote (elmo-pop3-port-label spec))))))
744 (defun elmo-pop3-set-plugged (spec plugged add)
745 (apply 'elmo-set-plugged plugged
746 (append (elmo-pop3-portinfo spec)
747 (list nil nil (quote (elmo-pop3-port-label spec)) add))))
749 (defalias 'elmo-pop3-sync-number-alist
750 'elmo-generic-sync-number-alist)
751 (defalias 'elmo-pop3-list-folder-unread
752 'elmo-generic-list-folder-unread)
753 (defalias 'elmo-pop3-list-folder-important
754 'elmo-generic-list-folder-important)
755 (defalias 'elmo-pop3-folder-diff 'elmo-generic-folder-diff)
757 (defun elmo-pop3-commit (spec)
758 (if (elmo-pop3-plugged-p spec)
759 (let ((session (elmo-pop3-get-session spec 'if-exists)))
761 (elmo-network-close-session session)))))
765 (product-provide (provide 'elmo-pop3) (require 'elmo-version))
767 ;;; elmo-pop3.el ends here