* elmo-imap4.el (elmo-network-authenticate-session): Always ask
[elisp/wanderlust.git] / elmo / elmo-imap4.el
1 ;;; elmo-imap4.el --- IMAP4 Interface for ELMO.
2
3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
4 ;; Copyright (C) 1999,2000      Kenichi OKADA <okada@opaopa.org>
5 ;; Copyright (C) 2000           OKAZAKI Tetsurou <okazaki@be.to>
6 ;; Copyright (C) 2000           Daiki Ueno <ueno@unixuser.org>
7
8 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
9 ;;      Kenichi OKADA <okada@opaopa.org>
10 ;;      OKAZAKI Tetsurou <okazaki@be.to>
11 ;;      Daiki Ueno <ueno@unixuser.org>
12 ;; Keywords: mail, net news
13
14 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
15
16 ;; This program is free software; you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; any later version.
20 ;;
21 ;; This program is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24 ;; GNU General Public License for more details.
25 ;;
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
28 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
29 ;; Boston, MA 02111-1307, USA.
30 ;;
31
32 ;;; Commentary:
33 ;;
34 ;; Origin of IMAP parser part is imap.el, included in Gnus.
35 ;;
36 ;;    Copyright (C) 1998, 1999, 2000
37 ;;    Free Software Foundation, Inc.
38 ;;    Author: Simon Josefsson <jas@pdc.kth.se>
39 ;;
40
41 ;;; Code:
42 (require 'elmo-vars)
43 (require 'elmo-util)
44 (require 'elmo-date)
45 (require 'elmo-msgdb)
46 (require 'elmo-cache)
47 (require 'elmo)
48 (require 'elmo-net)
49 (require 'utf7)
50 (require 'elmo-mime)
51 (require 'time-stamp)
52
53 (eval-when-compile (require 'cl))
54
55 (defvar elmo-imap4-disuse-server-flag-mailbox-regexp "^#mh" ; UW imapd
56   "Regexp to match IMAP4 mailbox names whose message flags on server should be ignored (For STATUS command).")
57
58 (defvar elmo-imap4-overview-fetch-chop-length 200
59   "*Number of overviews to fetch in one request.")
60
61 ;; c.f. rfc2683 3.2.1.5 Long Command Lines
62 ;;
63 ;; "A client should limit the length of the command lines it generates
64 ;;  to approximately 1000 octets (including all quoted strings but not
65 ;;  including literals). If the client is unable to group things into
66 ;;  ranges so that the command line is within that length, it should
67 ;;  split the request into multiple commands. The client should use
68 ;;  literals instead of long quoted strings, in order to keep the command
69 ;;  length down.
70 ;;  For its part, a server should allow for a command line of at least
71 ;;  8000 octets. This provides plenty of leeway for accepting reasonable
72 ;;  length commands from clients. The server should send a BAD response
73 ;;  to a command that does not end within the server's maximum accepted
74 ;;  command length. "
75
76 ;; To limit command line length, chop number set.
77 (defvar elmo-imap4-number-set-chop-length 1000
78   "*Number of messages to specify as a number-set argument for one request.")
79
80 (defvar elmo-imap4-force-login nil
81   "*Non-nil forces to try 'login' if there is no 'auth' capability in imapd.")
82
83 (defvar elmo-imap4-use-select-to-update-status nil
84   "*Some imapd have to send select command to update status.
85 \(ex. UW imapd 4.5-BETA?\).  For these imapd, you must set this variable t.")
86
87 (defvar elmo-imap4-use-modified-utf7 nil
88   "*Use mofidied UTF-7 (rfc2060) encoding for IMAP4 folder name.")
89
90 (defvar elmo-imap4-use-cache t
91   "Use cache in imap4 folder.")
92
93 (defvar elmo-imap4-extra-namespace-alist
94   '(("^\\({.*/nntp}\\).*$" . ".")) ; Default is for UW's remote nntp mailbox...
95   "Extra namespace alist.
96 A list of cons cell like: (REGEXP . DELIMITER).
97 REGEXP should have a grouping for namespace prefix.")
98
99 (defvar elmo-imap4-disabled-extensions nil
100   "List of server extensions that are disabled on the client side.")
101
102 ;;
103 ;;; internal variables
104 ;;
105 (defvar elmo-imap4-seq-prefix "elmo-imap4")
106 (defvar elmo-imap4-seqno 0)
107 (defvar elmo-imap4-use-uid t
108   "Use UID as message number.")
109
110 (defvar elmo-imap4-current-response nil)
111 (defvar elmo-imap4-status nil)
112 (defvar elmo-imap4-reached-tag "elmo-imap40")
113
114 ;;; buffer local variables
115 (defvar elmo-imap4-default-hierarchy-delimiter "/")
116
117 (defvar elmo-imap4-server-capability nil)
118 (defvar elmo-imap4-server-namespace nil)
119
120 (defvar elmo-imap4-parsing nil) ; indicates parsing.
121
122 (defvar elmo-imap4-fetch-callback nil)
123 (defvar elmo-imap4-fetch-callback-data nil)
124 (defvar elmo-imap4-status-callback nil)
125 (defvar elmo-imap4-status-callback-data nil)
126
127 (defvar elmo-imap4-server-diff-async-callback nil)
128 (defvar elmo-imap4-server-diff-async-callback-data nil)
129
130 ;;; progress...(no use?)
131 (defvar elmo-imap4-count-progress nil)
132 (defvar elmo-imap4-count-progress-message nil)
133 (defvar elmo-imap4-progress-count nil)
134
135 ;;; XXX Temporal implementation
136 (defvar elmo-imap4-current-msgdb nil)
137 (defvar elmo-imap4-seen-messages nil)
138
139 (defvar elmo-imap4-local-variables
140   '(elmo-imap4-status
141     elmo-imap4-current-response
142     elmo-imap4-seqno
143     elmo-imap4-parsing
144     elmo-imap4-reached-tag
145     elmo-imap4-count-progress
146     elmo-imap4-count-progress-message
147     elmo-imap4-progress-count
148     elmo-imap4-fetch-callback
149     elmo-imap4-fetch-callback-data
150     elmo-imap4-status-callback
151     elmo-imap4-status-callback-data
152     elmo-imap4-current-msgdb
153     elmo-imap4-seen-messages))
154
155 ;;;;
156
157 (defconst elmo-imap4-quoted-specials-list '(?\\ ?\"))
158
159 (defconst elmo-imap4-non-atom-char-regex
160   (eval-when-compile
161     (concat "[^" "]!#$&'+,./0-9:;<=>?@A-Z[^_`a-z|}~-" "]")))
162
163 (defconst elmo-imap4-non-text-char-regex
164   (eval-when-compile
165     (concat "[^"
166             "]\x01-\x09\x0b\x0c\x0e-\x1f\x7f !\"#$%&'()*+,./0-9:;<=>?@A-Z[\\^_`a-z{|}~-"
167             "]")))
168
169 (defconst elmo-imap4-literal-threshold 1024
170  "Limitation of characters that can be used in a quoted string.")
171
172 (defconst elmo-imap4-flag-specs '((important "\\Flagged")
173                                   (read "\\Seen")
174                                   (unread "\\Seen" 'remove)
175                                   (answered "\\Answered")
176                                   ;; draft-melnikov-imap-keywords-03.txt
177                                   (forwarded "$Forwarded")
178                                   (work "$Work")
179                                   (personal "$Personal")
180                                   (shouldreply "$ShouldReply")))
181
182 (defconst elmo-imap4-folder-name-syntax
183   `(mailbox
184     (?: [user "^[A-Za-z0-9]"] (?/ [auth ".+"]))
185     ,@elmo-net-folder-name-syntax))
186
187 ;; For debugging.
188 (defvar elmo-imap4-debug nil
189   "Non-nil forces IMAP4 folder as debug mode.
190 Debug information is inserted in the buffer \"*IMAP4 DEBUG*\"")
191
192 (defvar elmo-imap4-debug-inhibit-logging nil)
193
194 ;;; ELMO IMAP4 folder
195 (eval-and-compile
196   (luna-define-class elmo-imap4-folder (elmo-net-folder)
197                      (mailbox))
198   (luna-define-internal-accessors 'elmo-imap4-folder))
199
200 ;;; Session
201 (eval-and-compile
202   (luna-define-class elmo-imap4-session (elmo-network-session)
203                      (capability current-mailbox read-only flags))
204   (luna-define-internal-accessors 'elmo-imap4-session))
205
206 (defmacro elmo-imap4-session-capable-p (session capability)
207   `(and (memq ,capability (elmo-imap4-session-capability-internal ,session))
208         (not (memq ,capability elmo-imap4-disabled-extensions))))
209
210 ;;; MIME-ELMO-IMAP Location
211 (eval-and-compile
212   (luna-define-class mime-elmo-imap-location
213                      (mime-imap-location)
214                      (folder number rawbuf strategy))
215   (luna-define-internal-accessors 'mime-elmo-imap-location))
216
217 ;;; Debug
218 (defmacro elmo-imap4-debug (message &rest args)
219   `(if elmo-imap4-debug
220        (elmo-imap4-debug-1 ,message ,@args)))
221
222 (defun elmo-imap4-debug-1 (message &rest args)
223   (with-current-buffer (get-buffer-create "*IMAP4 DEBUG*")
224     (goto-char (point-max))
225     (if elmo-imap4-debug-inhibit-logging
226         (insert "NO LOGGING\n")
227       (insert (apply 'format message args) "\n"))))
228
229 (defsubst elmo-imap4-decode-folder-string (string)
230   (if elmo-imap4-use-modified-utf7
231       (utf7-decode string 'imap)
232     string))
233
234 (defsubst elmo-imap4-encode-folder-string (string)
235   (if elmo-imap4-use-modified-utf7
236       (utf7-encode string 'imap)
237     string))
238
239 ;;; Response
240
241 (defmacro elmo-imap4-response-continue-req-p (response)
242   "Returns non-nil if RESPONSE is '+' response."
243   `(assq 'continue-req ,response))
244
245 (defmacro elmo-imap4-response-ok-p (response)
246   "Returns non-nil if RESPONSE is an 'OK' response."
247   `(assq 'ok ,response))
248
249 (defmacro elmo-imap4-response-bye-p (response)
250   "Returns non-nil if RESPONSE is an 'BYE' response."
251   `(assq 'bye ,response))
252
253 (defmacro elmo-imap4-response-garbage-p (response)
254   "Returns non-nil if RESPONSE is an 'garbage' response."
255   `(assq 'garbage ,response))
256
257 (defmacro elmo-imap4-response-value (response symbol)
258   "Get value of the SYMBOL from RESPONSE."
259   `(nth 1 (assq ,symbol ,response)))
260
261 (defsubst elmo-imap4-response-value-all (response symbol)
262   "Get all value of the SYMBOL from RESPONSE."
263   (let (matched)
264     (while response
265       (if (eq (car (car response)) symbol)
266           (setq matched (nconc matched (nth 1 (car response)))))
267       (setq response (cdr response)))
268     matched))
269
270 (defmacro elmo-imap4-response-error-text (response)
271   "Returns text of NO, BAD, BYE response."
272   `(nth 1 (or (elmo-imap4-response-value ,response 'no)
273               (elmo-imap4-response-value ,response 'bad)
274               (elmo-imap4-response-value ,response 'bye))))
275
276 (defmacro elmo-imap4-response-bodydetail-text (response)
277   "Returns text of BODY[section]<partial>."
278   `(nth 3 (assq 'bodydetail ,response)))
279
280 ;;; Session commands.
281
282 ;;;(defun elmo-imap4-send-command-wait (session command)
283 ;;;  "Send COMMAND to the SESSION and wait for response.
284 ;;;Returns RESPONSE (parsed lisp object) of IMAP session."
285 ;;;  (elmo-imap4-read-response session
286 ;;;                         (elmo-imap4-send-command
287 ;;;                          session
288 ;;;                          command)))
289
290 (defun elmo-imap4-send-command-wait (session command)
291   "Send COMMAND to the SESSION.
292 Returns RESPONSE (parsed lisp object) of IMAP session.
293 If response is not `OK', causes error with IMAP response text."
294   (elmo-imap4-accept-ok session
295                         (elmo-imap4-send-command
296                          session
297                          command)))
298
299 (defun elmo-imap4-send-command (session command)
300   "Send COMMAND to the SESSION.
301 Returns a TAG string which is assigned to the COMMAND."
302   (let* ((command-args (if (listp command)
303                            command
304                          (list command)))
305          (process (elmo-network-session-process-internal session))
306          cmdstr tag token kind)
307     (with-current-buffer (process-buffer process)
308       (setq tag (concat elmo-imap4-seq-prefix
309                         (number-to-string
310                          (setq elmo-imap4-seqno (+ 1 elmo-imap4-seqno)))))
311       (setq cmdstr (concat tag " "))
312 ;;; No need.
313 ;;;      (erase-buffer)
314       (goto-char (point-min))
315       (when (elmo-imap4-response-bye-p elmo-imap4-current-response)
316         (elmo-imap4-process-bye session))
317       (setq elmo-imap4-current-response nil)
318       (when elmo-imap4-parsing
319         (message "Waiting for IMAP response...")
320         (accept-process-output (elmo-network-session-process-internal
321                                 session))
322         (message "Waiting for IMAP response...done"))
323       (setq elmo-imap4-parsing t)
324       (while (setq token (car command-args))
325         (cond ((stringp token)   ; formatted
326                (setq cmdstr (concat cmdstr token)))
327               ((listp token)     ; unformatted
328                (setq kind (car token))
329                (cond ((eq kind 'atom)
330                       (setq cmdstr (concat cmdstr (nth 1 token))))
331                      ((eq kind 'quoted)
332                       (setq cmdstr (concat
333                                     cmdstr
334                                     (elmo-imap4-format-quoted (nth 1 token)))))
335                      ((eq kind 'literal)
336                       (if (elmo-imap4-session-capable-p session 'literal+)
337                           ;; rfc2088
338                           (progn
339                             (setq cmdstr (concat cmdstr
340                                                  (format "{%d+}" (nth 2 token))
341                                                  "\r\n"))
342                             (process-send-string process cmdstr)
343                             (setq cmdstr nil))
344                         (setq cmdstr (concat cmdstr
345                                              (format "{%d}" (nth 2 token))
346                                              "\r\n"))
347                         (process-send-string process cmdstr)
348                         (setq cmdstr nil)
349                         (elmo-imap4-accept-continue-req session))
350                       (cond ((stringp (nth 1 token))
351                              (setq cmdstr (nth 1 token)))
352                             ((bufferp (nth 1 token))
353                              (with-current-buffer (nth 1 token)
354                                (process-send-region
355                                 process
356                                 (point-min)
357                                 (+ (point-min) (nth 2 token)))))
358                             (t
359                              (error "Wrong argument for literal"))))
360                      (t
361                       (error "Unknown token kind %s" kind))))
362               (t
363                (error "Invalid argument")))
364         (setq command-args (cdr command-args)))
365       (elmo-imap4-debug "[%s] <- %s" (format-time-string "%T") cmdstr)
366       (process-send-string process (concat cmdstr "\r\n"))
367       tag)))
368
369 (defun elmo-imap4-send-string (session string)
370   "Send STRING to the SESSION."
371   (with-current-buffer (process-buffer
372                         (elmo-network-session-process-internal session))
373     (setq elmo-imap4-current-response nil)
374     (goto-char (point-min))
375     (elmo-imap4-debug "[%s] <-- %s" (format-time-string "%T") string)
376     (process-send-string (elmo-network-session-process-internal session)
377                          string)
378     (process-send-string (elmo-network-session-process-internal session)
379                          "\r\n")))
380
381 (defun elmo-imap4-read-response (session tag)
382   "Read parsed response from SESSION.
383 TAG is the tag of the command"
384   (with-current-buffer (process-buffer
385                         (elmo-network-session-process-internal session))
386     (while (not (or (string= tag elmo-imap4-reached-tag)
387                     (elmo-imap4-response-bye-p elmo-imap4-current-response)
388                     (when (elmo-imap4-response-garbage-p
389                            elmo-imap4-current-response)
390                       (message "Garbage response: %s"
391                                (elmo-imap4-response-value
392                                 elmo-imap4-current-response
393                                 'garbage))
394                       t)))
395       (when (memq (process-status
396                    (elmo-network-session-process-internal session))
397                   '(open run))
398         (accept-process-output (elmo-network-session-process-internal session)
399                                1)))
400     (elmo-imap4-debug "[%s] => %s" (format-time-string "%T") (prin1-to-string elmo-imap4-current-response))
401     (setq elmo-imap4-parsing nil)
402     elmo-imap4-current-response))
403
404 (defsubst elmo-imap4-read-untagged (process)
405   (with-current-buffer (process-buffer process)
406     (while (not elmo-imap4-current-response)
407       (accept-process-output process 1))
408     (elmo-imap4-debug "[%s] =>%s" (format-time-string "%T") (prin1-to-string elmo-imap4-current-response))
409     elmo-imap4-current-response))
410
411 (defun elmo-imap4-read-continue-req (session)
412   "Returns a text following to continue-req in SESSION.
413 If response is not `+' response, returns nil."
414   (elmo-imap4-response-value
415    (elmo-imap4-read-untagged
416     (elmo-network-session-process-internal session))
417    'continue-req))
418
419 (defun elmo-imap4-process-bye (session)
420   (with-current-buffer (elmo-network-session-buffer session)
421     (let ((r elmo-imap4-current-response))
422       (setq elmo-imap4-current-response nil)
423       (elmo-network-close-session session)
424       (signal 'elmo-imap4-bye-error
425               (list (concat (elmo-imap4-response-error-text r))
426                     "Try Again")))))
427
428 (defun elmo-imap4-accept-continue-req (session)
429   "Returns non-nil if `+' (continue-req) response is arrived in SESSION.
430 If response is not `+' response, cause an error."
431   (let (response)
432     (setq response
433           (elmo-imap4-read-untagged
434            (elmo-network-session-process-internal session)))
435     (or (elmo-imap4-response-continue-req-p response)
436         (error "IMAP error: %s"
437                (or (elmo-imap4-response-error-text response)
438                    "No continut-req from server.")))))
439
440 (defun elmo-imap4-read-ok (session tag)
441   "Returns non-nil if `OK' response of the command with TAG is arrived
442 in SESSION. If response is not `OK' response, returns nil."
443   (elmo-imap4-response-ok-p
444    (elmo-imap4-read-response session tag)))
445
446 (defun elmo-imap4-accept-ok (session tag)
447   "Accept only `OK' response from SESSION.
448 If response is not `OK' response, causes error with IMAP response text."
449   (let ((response (elmo-imap4-read-response session tag)))
450     (if (elmo-imap4-response-ok-p response)
451         response
452       (if (elmo-imap4-response-bye-p response)
453           (elmo-imap4-process-bye session)
454         (error "IMAP error: %s"
455                (or (elmo-imap4-response-error-text response)
456                    "No `OK' response from server."))))))
457
458 ;;; MIME-ELMO-IMAP Location
459 (luna-define-method mime-imap-location-section-body ((location
460                                                       mime-elmo-imap-location)
461                                                      section)
462   (if (and (stringp section)
463            (string= section "HEADER"))
464       ;; Even in the section mode, header fields should be saved to the
465       ;; raw buffer .
466       (with-current-buffer (mime-elmo-imap-location-rawbuf-internal location)
467         (erase-buffer)
468         (elmo-message-fetch
469          (mime-elmo-imap-location-folder-internal location)
470          (mime-elmo-imap-location-number-internal location)
471          (mime-elmo-imap-location-strategy-internal location)
472          'unseen
473          section)
474         (buffer-string))
475     (elmo-message-fetch-string
476      (mime-elmo-imap-location-folder-internal location)
477      (mime-elmo-imap-location-number-internal location)
478      (mime-elmo-imap-location-strategy-internal location)
479      'unseen
480      section)))
481
482
483 (luna-define-method mime-imap-location-bodystructure
484   ((location mime-elmo-imap-location))
485   (elmo-message-fetch-bodystructure
486    (mime-elmo-imap-location-folder-internal location)
487    (mime-elmo-imap-location-number-internal location)
488    (mime-elmo-imap-location-strategy-internal location)))
489
490 (luna-define-method mime-imap-location-fetch-entity-p
491   ((location mime-elmo-imap-location) entity)
492   (or (not elmo-message-displaying) ; Fetching entity to save or force display.
493       ;; cache exists
494       (file-exists-p
495        (expand-file-name
496         (mmimap-entity-section (mime-entity-node-id-internal entity))
497         (elmo-fetch-strategy-cache-path
498          (mime-elmo-imap-location-strategy-internal location))))
499       ;; not too large to fetch.
500       (> elmo-message-fetch-threshold
501          (or (mime-imap-entity-size-internal entity) 0))))
502
503 ;;;
504
505 (defun elmo-imap4-session-check (session)
506   (with-current-buffer (elmo-network-session-buffer session)
507     (setq elmo-imap4-fetch-callback nil)
508     (setq elmo-imap4-fetch-callback-data nil))
509   (elmo-imap4-send-command session "check"))
510
511 (defun elmo-imap4-atom-p (string)
512   "Return t if STRING is an atom defined in rfc2060."
513   (if (string= string "")
514       nil
515     (save-match-data
516       (not (string-match elmo-imap4-non-atom-char-regex string)))))
517
518 (defun elmo-imap4-quotable-p (string)
519   "Return t if STRING can be formatted as a quoted defined in rfc2060."
520   (save-match-data
521     (not (string-match elmo-imap4-non-text-char-regex string))))
522
523 (defun elmo-imap4-nil (string)
524   "Return a list represents the special atom \"NIL\" defined in rfc2060, \
525 if STRING is nil.
526 Otherwise return nil."
527   (if (eq string nil)
528       (list 'atom "NIL")))
529
530 (defun elmo-imap4-atom (string)
531   "Return a list represents STRING as an atom defined in rfc2060.
532 Return nil if STRING is not an atom.  See `elmo-imap4-atom-p'."
533   (if (elmo-imap4-atom-p string)
534       (list 'atom string)))
535
536 (defun elmo-imap4-quoted (string)
537   "Return a list represents STRING as a quoted defined in rfc2060.
538 Return nil if STRING can not be formatted as a quoted.  See `elmo-imap4-quotable-p'."
539   (if (elmo-imap4-quotable-p string)
540       (list 'quoted string)))
541
542 (defun elmo-imap4-literal-1 (string-or-buffer length)
543   "Internal function for `elmo-imap4-literal' and `elmo-imap4-buffer-literal'.
544 Return a list represents STRING-OR-BUFFER as a literal defined in rfc2060.
545 STRING-OR-BUFFER must be an encoded string or a single-byte string or a single-byte buffer.
546 LENGTH must be the number of octets for STRING-OR-BUFFER."
547   (list 'literal string-or-buffer length))
548
549 (defun elmo-imap4-literal (string)
550   "Return a list represents STRING as a literal defined in rfc2060.
551 STRING must be an encoded or a single-byte string."
552   (elmo-imap4-literal-1 string (length string)))
553
554 (defun elmo-imap4-buffer-literal (buffer)
555   "Return a list represents BUFFER as a literal defined in rfc2060.
556 BUFFER must be a single-byte buffer."
557   (elmo-imap4-literal-1 buffer (with-current-buffer buffer
558                                  (buffer-size))))
559
560 (defun elmo-imap4-string-1 (string length)
561   "Internal function for `elmo-imap4-string' and `elmo-imap4-buffer-string'.
562 Return a list represents STRING as a string defined in rfc2060.
563 STRING must be an encoded or a single-byte string.
564 LENGTH must be the number of octets for STRING."
565   (or (elmo-imap4-quoted string)
566       (elmo-imap4-literal-1 string length)))
567
568 (defun elmo-imap4-string (string)
569   "Return a list represents STRING as a string defined in rfc2060.
570 STRING must be an encoded or a single-byte string."
571   (let ((length (length string)))
572     (if (< elmo-imap4-literal-threshold length)
573         (elmo-imap4-literal-1 string length)
574       (elmo-imap4-string-1 string length))))
575
576 (defun elmo-imap4-buffer-string (buffer)
577   "Return a list represents BUFFER as a string defined in rfc2060.
578 BUFFER must be a single-byte buffer."
579   (let ((length (with-current-buffer buffer
580                   (buffer-size))))
581     (if (< elmo-imap4-literal-threshold length)
582         (elmo-imap4-literal-1 buffer length)
583       (elmo-imap4-string-1 (with-current-buffer buffer
584                              (buffer-string))
585                            length))))
586
587 (defun elmo-imap4-astring-1 (string length)
588   "Internal function for `elmo-imap4-astring' and `elmo-imap4-buffer-astring'.
589 Return a list represents STRING as an astring defined in rfc2060.
590 STRING must be an encoded or a single-byte string.
591 LENGTH must be the number of octets for STRING."
592   (or (elmo-imap4-atom string)
593       (elmo-imap4-string-1 string length)))
594
595 (defun elmo-imap4-astring (string)
596   "Return a list represents STRING as an astring defined in rfc2060.
597 STRING must be an encoded or a single-byte string."
598   (let ((length (length string)))
599     (if (< elmo-imap4-literal-threshold length)
600         (elmo-imap4-literal-1 string length)
601       (elmo-imap4-astring-1 string length))))
602
603 (defun elmo-imap4-buffer-astring (buffer)
604   "Return a list represents BUFFER as an astring defined in rfc2060.
605 BUFFER must be a single-byte buffer."
606   (let ((length (with-current-buffer buffer
607                   (buffer-size))))
608     (if (< elmo-imap4-literal-threshold length)
609         (elmo-imap4-literal-1 buffer length)
610       (elmo-imap4-astring-1 (with-current-buffer buffer
611                               (buffer-string))
612                             length))))
613
614 (defun elmo-imap4-nstring (string)
615   "Return a list represents STRING as a nstring defined in rfc2060.
616 STRING must be an encoded or a single-byte string."
617    (or (elmo-imap4-nil string)
618        (elmo-imap4-string string)))
619
620 (defun elmo-imap4-buffer-nstring (buffer)
621   "Return a list represents BUFFER as a nstring defined in rfc2060.
622 BUFFER must be a single-byte buffer."
623    (or (elmo-imap4-nil buffer)
624        (elmo-imap4-buffer-string buffer)))
625
626 (defalias 'elmo-imap4-mailbox 'elmo-imap4-astring)
627 (defalias 'elmo-imap4-field-body 'elmo-imap4-astring)
628 (defalias 'elmo-imap4-userid 'elmo-imap4-astring)
629 (defalias 'elmo-imap4-password 'elmo-imap4-astring)
630
631 (defun elmo-imap4-format-quoted (string)
632   "Return STRING in a form of the quoted-string defined in rfc2060."
633   (concat "\""
634           (std11-wrap-as-quoted-pairs string elmo-imap4-quoted-specials-list)
635           "\""))
636
637 (defsubst elmo-imap4-response-get-selectable-mailbox-list (response)
638   (delq nil
639         (mapcar
640          (lambda (entry)
641            (if (and (eq 'list (car entry))
642                     (not (elmo-string-member-ignore-case "\\Noselect" (nth 1 (nth 1 entry)))))
643                (car (nth 1 entry))))
644          response)))
645
646 (luna-define-method elmo-message-fetch-bodystructure ((folder
647                                                        elmo-imap4-folder)
648                                                       number strategy)
649   (if (elmo-fetch-strategy-use-cache strategy)
650       (elmo-object-load
651        (elmo-file-cache-expand-path
652         (elmo-fetch-strategy-cache-path strategy)
653         "bodystructure"))
654     (let ((session (elmo-imap4-get-session folder))
655           bodystructure)
656       (elmo-imap4-session-select-mailbox
657        session
658        (elmo-imap4-folder-mailbox-internal folder))
659       (with-current-buffer (elmo-network-session-buffer session)
660         (setq elmo-imap4-fetch-callback nil)
661         (setq elmo-imap4-fetch-callback-data nil))
662       (prog1 (setq bodystructure
663                    (elmo-imap4-response-value
664                     (elmo-imap4-response-value
665                      (elmo-imap4-send-command-wait
666                       session
667                       (format
668                        (if elmo-imap4-use-uid
669                            "uid fetch %s bodystructure"
670                          "fetch %s bodystructure")
671                        number))
672                      'fetch)
673                     'bodystructure))
674         (when (elmo-fetch-strategy-save-cache strategy)
675           (elmo-file-cache-delete
676            (elmo-fetch-strategy-cache-path strategy))
677           (elmo-object-save
678            (elmo-file-cache-expand-path
679             (elmo-fetch-strategy-cache-path strategy)
680             "bodystructure")
681            bodystructure))))))
682
683 ;;; Backend methods.
684 (luna-define-method elmo-create-folder-plugged ((folder elmo-imap4-folder))
685   (elmo-imap4-send-command-wait
686    (elmo-imap4-get-session folder)
687    (list "create " (elmo-imap4-mailbox
688                     (elmo-imap4-folder-mailbox-internal folder)))))
689
690 (defun elmo-imap4-get-session (folder &optional if-exists)
691   (elmo-network-get-session 'elmo-imap4-session
692                             (concat
693                              (if (elmo-folder-biff-internal folder)
694                                  "BIFF-")
695                              "IMAP")
696                             folder if-exists))
697
698 (defun elmo-imap4-session-select-mailbox (session mailbox
699                                                   &optional force no-error)
700   "Select MAILBOX in SESSION.
701 If optional argument FORCE is non-nil, select mailbox even if current mailbox
702 is same as MAILBOX.
703 If second optional argument NO-ERROR is non-nil, don't cause an error when
704 selecting folder was failed.
705 If NO-ERROR is 'notify-bye, only BYE response is reported as error.
706 Returns response value if selecting folder succeed. "
707   (when (or force
708             (not (string=
709                   (elmo-imap4-session-current-mailbox-internal session)
710                   mailbox)))
711     (let (response result)
712       (unwind-protect
713           (setq response
714                 (elmo-imap4-read-response
715                  session
716                  (elmo-imap4-send-command
717                   session
718                   (list
719                    "select "
720                    (elmo-imap4-mailbox mailbox)))))
721         (if (setq result (elmo-imap4-response-ok-p response))
722             (progn
723               (elmo-imap4-session-set-current-mailbox-internal session mailbox)
724               (elmo-imap4-session-set-read-only-internal
725                session
726                (nth 1 (assq 'read-only (assq 'ok response))))
727               (elmo-imap4-session-set-flags-internal
728                session
729                (nth 1 (or (assq 'permanentflags response)
730                           (assq 'flags response)))))
731           (elmo-imap4-session-set-current-mailbox-internal session nil)
732           (if (and (eq no-error 'notify-bye)
733                    (elmo-imap4-response-bye-p response))
734               (elmo-imap4-process-bye session)
735             (unless no-error
736               (error "%s"
737                      (or (elmo-imap4-response-error-text response)
738                          (format "Select %s failed" mailbox)))))))
739       (and result response))))
740
741 (defun elmo-imap4-check-validity (spec validity-file)
742 ;;; Not used.
743 ;;;(elmo-imap4-send-command-wait
744 ;;;(elmo-imap4-get-session spec)
745 ;;;(list "status "
746 ;;;      (elmo-imap4-mailbox
747 ;;;       (elmo-imap4-spec-mailbox spec))
748 ;;;      " (uidvalidity)")))
749   )
750
751 (defun elmo-imap4-sync-validity  (spec validity-file)
752   ;; Not used.
753   )
754
755 (defun elmo-imap4-elist (folder query tags)
756   (let ((session (elmo-imap4-get-session folder)))
757     (elmo-imap4-session-select-mailbox
758      session
759      (elmo-imap4-folder-mailbox-internal folder))
760     (let ((answer (elmo-imap4-response-value
761                    (elmo-imap4-send-command-wait
762                     session query) 'esearch))
763           tag result)
764       (while answer
765         (setq tag (intern (downcase (car answer))))
766         (cond ((eq tag 'uid)
767                nil)
768               ((memq tag tags)
769                (setq result
770                      (append result
771                              (if (eq tag 'all)
772                                  (sort
773                                   (elmo-number-set-to-number-list
774                                    (mapcar #'(lambda (x)
775                                                (let ((y (split-string x ":")))
776                                                  (if (null (cdr y))
777                                                      (string-to-number (car y))
778                                                    (cons (string-to-number (car y))
779                                                          (string-to-number (cadr y))))))
780                                            (split-string (cadr answer) "\,"))) '<)
781                                (string-to-number (cadr answer))))))
782               (t nil))
783         (setq answer (cdr answer)))
784       result)))
785
786 (defun elmo-imap4-list (folder flag)
787   (let ((session (elmo-imap4-get-session folder)))
788     (elmo-imap4-session-select-mailbox
789      session
790      (elmo-imap4-folder-mailbox-internal folder))
791     (if (elmo-imap4-session-capable-p session 'esearch)
792         (elmo-imap4-elist folder
793                           (concat (if elmo-imap4-use-uid "uid " "")
794                                   "search return (all) " flag) '(all))
795       (elmo-imap4-response-value
796        (elmo-imap4-send-command-wait
797         session
798         (format (if elmo-imap4-use-uid "uid search %s"
799                   "search %s") flag))
800        'search))))
801
802 (defun elmo-imap4-session-flag-available-p (session flag)
803   (case flag
804     ((read unread) (elmo-string-member-ignore-case
805                     "\\seen" (elmo-imap4-session-flags-internal session)))
806     (important
807      (elmo-string-member-ignore-case
808       "\\flagged" (elmo-imap4-session-flags-internal session)))
809     (digest
810      (or (elmo-string-member-ignore-case
811           "\\seen" (elmo-imap4-session-flags-internal session))
812          (elmo-string-member-ignore-case
813           "\\flagged" (elmo-imap4-session-flags-internal session))))
814     (answered
815      (elmo-string-member-ignore-case
816       (concat "\\" (symbol-name flag))
817       (elmo-imap4-session-flags-internal session)))
818     (t
819      (member "\\*" (elmo-imap4-session-flags-internal session)))))
820
821 (defun elmo-imap4-flag-to-imap-search-key (flag)
822   (case flag
823     (read "seen")
824     (unread "unseen")
825     (important "flagged")
826     (answered "answered")
827     (new "new")
828     (t (concat
829         "keyword "
830         (or (car (cdr (assq flag elmo-imap4-flag-specs)))
831             (symbol-name flag))))))
832
833 (defun elmo-imap4-flag-to-imap-criteria (flag)
834   (case flag
835     ((any digest)
836      (let ((criteria "flagged")
837            (global-flags (delq 'important (elmo-get-global-flags t t))))
838        (dolist (flag (delete 'new
839                              (delete 'cached
840                                      (copy-sequence
841                                       (case flag
842                                         (any
843                                          elmo-preserved-flags)
844                                         (digest
845                                          elmo-digest-flags))))))
846          (setq criteria (concat "or "
847                                 (elmo-imap4-flag-to-imap-search-key flag)
848                                 " "
849                                 criteria)))
850        (while global-flags
851          (setq criteria (concat "or keyword "
852                                 (symbol-name (car global-flags))
853                                 " "
854                                 criteria))
855          (setq global-flags (cdr global-flags)))
856        criteria))
857     (t
858      (elmo-imap4-flag-to-imap-search-key flag))))
859
860 (defun elmo-imap4-folder-list-flagged (folder flag &optional type)
861   "List flagged message numbers in the FOLDER.
862 FLAG is one of the `unread', `read', `important', `answered',
863 `any'.
864 When optional argument TYPE is symbol 'unmatch, negate search
865 condition."
866   (let ((session (elmo-imap4-get-session folder))
867         (criteria (concat (if (eq type 'unmatch) "not " "")
868                           (elmo-imap4-flag-to-imap-criteria flag))))
869     (if (elmo-imap4-session-flag-available-p session flag)
870         (elmo-imap4-list folder criteria)
871       ;; List flagged messages in the msgdb.
872       (elmo-msgdb-list-flagged (elmo-folder-msgdb folder) flag))))
873
874 (defvar elmo-imap4-rfc822-size "RFC822\.SIZE")
875 (defvar elmo-imap4-rfc822-text "RFC822\.TEXT")
876 (defvar elmo-imap4-rfc822-header "RFC822\.HEADER")
877 (defvar elmo-imap4-header-fields "HEADER\.FIELDS")
878
879 (defun elmo-imap4-make-number-set-list (msg-list &optional chop-length)
880   "Make RFC2060's message set specifier from MSG-LIST.
881 Returns a list of (NUMBER . SET-STRING).
882 SET-STRING is the message set specifier described in RFC2060.
883 NUMBER is contained message number in SET-STRING.
884 Every SET-STRING does not contain number of messages longer than CHOP-LENGTH.
885 If CHOP-LENGTH is not specified, message set is not chopped."
886   (let (count cont-list set-list)
887     (setq msg-list (sort (copy-sequence msg-list) '<))
888     (while msg-list
889       (setq cont-list nil)
890       (setq count 0)
891       (unless chop-length
892         (setq chop-length (length msg-list)))
893       (while (and (not (null msg-list))
894                   (< count chop-length))
895         (setq cont-list
896               (elmo-number-set-append
897                cont-list (car msg-list)))
898         (incf count)
899         (setq msg-list (cdr msg-list)))
900       (setq set-list
901             (cons
902              (cons
903               count
904               (mapconcat
905                (lambda (x)
906                  (cond ((consp x)
907                         (format "%s:%s" (car x) (cdr x)))
908                        ((integerp x)
909                         (number-to-string x))))
910                cont-list
911                ","))
912              set-list)))
913     (nreverse set-list)))
914
915 ;;
916 ;; app-data:
917 ;; cons of flag-table and folder structure
918 (defsubst elmo-imap4-fetch-callback-1-subr (entity flags app-data)
919   "A msgdb entity callback function."
920   (let ((use-flag (elmo-folder-use-flag-p (cdr app-data)))
921         (flag-table (car app-data))
922         (msg-id (elmo-message-entity-field entity 'message-id))
923         saved-flags flag-list)
924 ;;;    (when (elmo-string-member-ignore-case "\\Flagged" flags)
925 ;;;      (elmo-msgdb-global-mark-set msg-id elmo-msgdb-important-mark))
926     (setq saved-flags (elmo-flag-table-get flag-table msg-id)
927           flag-list
928           (if use-flag
929               (append
930                (and (memq 'new saved-flags)
931                     (not (elmo-string-member-ignore-case "\\Seen" flags))
932                     '(new))
933                (and (elmo-string-member-ignore-case "\\Flagged" flags)
934                     '(important))
935                (and (not (elmo-string-member-ignore-case "\\Seen" flags))
936                     '(unread))
937                (and (elmo-string-member-ignore-case "\\Answered" flags)
938                     '(answered))
939                (and (elmo-file-cache-exists-p msg-id)
940                     '(cached)))
941             saved-flags))
942     (when (and (or (memq 'important flag-list)
943                    (memq 'answered flag-list))
944                (memq 'unread flag-list))
945       (setq elmo-imap4-seen-messages
946             (cons (elmo-message-entity-number entity)
947                   elmo-imap4-seen-messages)))
948     (elmo-msgdb-append-entity elmo-imap4-current-msgdb
949                               entity
950                               flag-list)))
951
952 ;; Current buffer is process buffer.
953 (defun elmo-imap4-fetch-callback-1 (element app-data)
954   (let ((handler (elmo-msgdb-message-entity-handler elmo-imap4-current-msgdb)))
955     (elmo-imap4-fetch-callback-1-subr
956      (with-temp-buffer
957        (insert (or (elmo-imap4-response-bodydetail-text element)
958                    ""))
959        ;; Replace all CRLF with LF.
960        (elmo-delete-cr-buffer)
961        (elmo-msgdb-create-message-entity-from-buffer
962         handler
963         (elmo-imap4-response-value element 'uid)
964         :size (elmo-imap4-response-value element 'rfc822size)))
965      (elmo-imap4-response-value element 'flags)
966      app-data)
967     (elmo-progress-notify 'elmo-folder-msgdb-create)))
968
969 (defun elmo-imap4-parse-capability (string)
970   (if (string-match "^\\*\\(.*\\)$" string)
971       (read
972        (concat "(" (downcase (elmo-match-string 1 string)) ")"))))
973
974 (defun elmo-imap4-clear-login (session)
975   (when (elmo-imap4-session-capable-p session 'logindisabled)
976     (signal 'elmo-authenticate-error '(elmo-imap4-clear-login)))
977   (let ((elmo-imap4-debug-inhibit-logging t))
978     (or
979      (elmo-imap4-read-ok
980       session
981       (elmo-imap4-send-command
982        session
983        (list "login "
984              (elmo-imap4-userid (elmo-network-session-user-internal session))
985              " "
986              (elmo-imap4-password
987               (elmo-get-passwd (elmo-network-session-password-key session))))))
988      (signal 'elmo-authenticate-error '(elmo-imap4-clear-login)))))
989
990 (defun elmo-imap4-auth-login (session)
991   (let ((tag (elmo-imap4-send-command session "authenticate login"))
992         (elmo-imap4-debug-inhibit-logging t))
993     (or (elmo-imap4-read-continue-req session)
994         (signal 'elmo-authenticate-error '(elmo-imap4-auth-login)))
995     (elmo-imap4-send-string session
996                             (elmo-base64-encode-string
997                              (elmo-network-session-user-internal session)))
998     (or (elmo-imap4-read-continue-req session)
999         (signal 'elmo-authenticate-error '(elmo-imap4-auth-login)))
1000     (elmo-imap4-send-string session
1001                             (elmo-base64-encode-string
1002                              (elmo-get-passwd
1003                               (elmo-network-session-password-key session))))
1004     (or (elmo-imap4-read-ok session tag)
1005         (signal 'elmo-authenticate-error '(elmo-imap4-auth-login)))
1006     (setq elmo-imap4-status 'auth)))
1007
1008 (luna-define-method
1009   elmo-network-initialize-session-buffer :after ((session
1010                                                   elmo-imap4-session) buffer)
1011   (with-current-buffer buffer
1012     (mapc 'make-variable-buffer-local elmo-imap4-local-variables)
1013     (setq elmo-imap4-seqno 0)
1014     (setq elmo-imap4-status 'initial)))
1015
1016 (luna-define-method elmo-network-initialize-session ((session
1017                                                       elmo-imap4-session))
1018   (let ((process (elmo-network-session-process-internal session)))
1019     (with-current-buffer (process-buffer process)
1020       ;; Skip garbage output from process before greeting.
1021       (while (and (memq (process-status process) '(open run))
1022                   (goto-char (point-max))
1023                   (or (/= (forward-line -1) 0)
1024                       (not (elmo-imap4-parse-greeting))))
1025         (accept-process-output process 1))
1026       (erase-buffer)
1027       (set-process-filter process 'elmo-imap4-arrival-filter)
1028       (set-process-sentinel process 'elmo-imap4-sentinel)
1029 ;;;      (while (and (memq (process-status process) '(open run))
1030 ;;;               (eq elmo-imap4-status 'initial))
1031 ;;;     (message "Waiting for server response...")
1032 ;;;     (accept-process-output process 1))
1033 ;;;      (message "")
1034       (unless (memq elmo-imap4-status '(nonauth auth))
1035         (signal 'elmo-open-error
1036                 (list 'elmo-network-initialize-session)))
1037       (elmo-imap4-session-set-capability-internal
1038        session
1039        (elmo-imap4-response-value
1040         (elmo-imap4-send-command-wait session "capability")
1041         'capability))
1042       (when (eq (elmo-network-stream-type-symbol
1043                  (elmo-network-session-stream-type-internal session))
1044                 'starttls)
1045         (or (elmo-imap4-session-capable-p session 'starttls)
1046             (signal 'elmo-open-error
1047                     '(elmo-imap4-starttls-error)))
1048         (elmo-imap4-send-command-wait session "starttls")
1049         (starttls-negotiate process)
1050         (elmo-imap4-session-set-capability-internal
1051          session
1052          (elmo-imap4-response-value
1053           (elmo-imap4-send-command-wait session "capability")
1054           'capability))))))
1055
1056 (luna-define-method elmo-network-authenticate-session ((session
1057                                                         elmo-imap4-session))
1058   (with-current-buffer (process-buffer
1059                         (elmo-network-session-process-internal session))
1060     (let* ((auth (elmo-network-session-auth-internal session))
1061            (auth (if (listp auth) auth (list auth))))
1062       (unless (or (eq elmo-imap4-status 'auth)
1063                   (null auth))
1064         (cond
1065          ((eq 'clear (car auth))
1066           (elmo-imap4-clear-login session))
1067          ((eq 'login (car auth))
1068           (elmo-imap4-auth-login session))
1069          (t
1070           (let* ((elmo-imap4-debug-inhibit-logging t)
1071                  (sasl-mechanisms
1072                   (delq nil
1073                         (mapcar
1074                          (lambda (cap)
1075                            (if (string-match "^auth=\\(.*\\)$"
1076                                              (symbol-name cap))
1077                                (match-string 1 (upcase (symbol-name cap)))))
1078                          (elmo-imap4-session-capability-internal session))))
1079                  (mechanism
1080                   (sasl-find-mechanism
1081                    (delq nil
1082                          (mapcar (lambda (cap) (upcase (symbol-name cap)))
1083                                  (if (listp auth)
1084                                      auth
1085                                    (list auth)))))) ;)
1086                  client name step response tag
1087                  sasl-read-passphrase)
1088             (unless mechanism
1089               (if (or elmo-imap4-force-login
1090                       (y-or-n-p
1091                        (format
1092                         "There's no %s capability in server. continue?"
1093                         (elmo-list-to-string
1094                          (elmo-network-session-auth-internal session)))))
1095                   (setq mechanism (sasl-find-mechanism
1096                                    sasl-mechanisms))
1097                 (signal 'elmo-authenticate-error
1098                         '(elmo-imap4-auth-no-mechanisms))))
1099             (setq client
1100                   (sasl-make-client
1101                    mechanism
1102                    (elmo-network-session-user-internal session)
1103                    "imap"
1104                    (elmo-network-session-server-internal session)))
1105 ;;;         (if elmo-imap4-auth-user-realm
1106 ;;;             (sasl-client-set-property client 'realm elmo-imap4-auth-user-realm))
1107             (setq name (sasl-mechanism-name mechanism)
1108                   step (sasl-next-step client nil))
1109             (elmo-network-session-set-auth-internal
1110              session
1111              (intern (downcase name)))
1112             (setq sasl-read-passphrase
1113                   (lambda (prompt)
1114                     (elmo-get-passwd
1115                      (elmo-network-session-password-key session))))
1116             (setq tag
1117                   (elmo-imap4-send-command
1118                    session
1119                    (concat "AUTHENTICATE " name
1120                            (and (sasl-step-data step)
1121                                 (concat
1122                                  " "
1123                                  (elmo-base64-encode-string
1124                                   (sasl-step-data step)
1125                                   'no-lin-break))))))
1126             (catch 'done
1127               (while t
1128                 (setq response
1129                       (elmo-imap4-read-untagged
1130                        (elmo-network-session-process-internal session)))
1131                 (if (elmo-imap4-response-ok-p response)
1132                     (if (sasl-next-step client step)
1133                         ;; Bogus server?
1134                         (signal 'elmo-authenticate-error
1135                                 (list (intern
1136                                        (concat "elmo-imap4-auth-"
1137                                                (downcase name)))))
1138                       ;; The authentication process is finished.
1139                       (throw 'done nil)))
1140                 (unless (elmo-imap4-response-continue-req-p response)
1141                   ;; response is NO or BAD.
1142                   (signal 'elmo-authenticate-error
1143                           (list (intern
1144                                  (concat "elmo-imap4-auth-"
1145                                          (downcase name))))))
1146                 (sasl-step-set-data
1147                  step
1148                  (elmo-base64-decode-string
1149                   (elmo-imap4-response-value response 'continue-req)))
1150                 (setq step (sasl-next-step client step))
1151                 (setq tag
1152                       (elmo-imap4-send-string
1153                        session
1154                        (if (sasl-step-data step)
1155                            (elmo-base64-encode-string (sasl-step-data step)
1156                                                       'no-line-break)
1157                          ""))))))))
1158 ;; Some servers return reduced capabilities when client asks for them
1159 ;; before login. It might be a good idea to ask them again, otherwise
1160 ;; we can miss some useful feature.
1161         (elmo-imap4-session-set-capability-internal
1162          session
1163          (elmo-imap4-response-value
1164           (elmo-imap4-send-command-wait session "capability")
1165           'capability))))))
1166
1167 (luna-define-method elmo-network-setup-session ((session
1168                                                  elmo-imap4-session))
1169   (with-current-buffer (elmo-network-session-buffer session)
1170     (when (elmo-imap4-session-capable-p session 'namespace)
1171       (setq elmo-imap4-server-namespace
1172             (elmo-imap4-response-value
1173              (elmo-imap4-send-command-wait session "namespace")
1174              'namespace)))))
1175
1176 (defun elmo-imap4-setup-send-buffer (&optional string)
1177   (let ((send-buf (get-buffer-create " *elmo-imap4-setup-send-buffer*"))
1178         (source-buf (unless string (current-buffer))))
1179     (save-excursion
1180       (save-match-data
1181         (set-buffer send-buf)
1182         (erase-buffer)
1183         (set-buffer-multibyte nil)
1184         (if string
1185             (insert string)
1186           (with-current-buffer source-buf
1187             (copy-to-buffer send-buf (point-min) (point-max))))
1188         (goto-char (point-min))
1189         (if (eq (re-search-forward "^$" nil t)
1190                 (point-max))
1191             (insert "\n"))
1192         (goto-char (point-min))
1193         (while (search-forward "\n" nil t)
1194           (replace-match "\r\n"))))
1195     send-buf))
1196
1197 (defun elmo-imap4-setup-send-buffer-from-file (file)
1198   (let ((tmp-buf (get-buffer-create
1199                   " *elmo-imap4-setup-send-buffer-from-file*")))
1200     (save-excursion
1201       (save-match-data
1202         (set-buffer tmp-buf)
1203         (erase-buffer)
1204         (as-binary-input-file
1205          (insert-file-contents file))
1206         (goto-char (point-min))
1207         (if (eq (re-search-forward "^$" nil t)
1208                 (point-max))
1209             (insert "\n"))
1210         (goto-char (point-min))
1211         (while (search-forward "\n" nil t)
1212           (replace-match "\r\n"))))
1213     tmp-buf))
1214
1215 (luna-define-method elmo-delete-message-safe ((folder elmo-imap4-folder)
1216                                               number msgid)
1217   (let ((session (elmo-imap4-get-session folder))
1218         candidates)
1219     (elmo-imap4-session-select-mailbox
1220      session
1221      (elmo-imap4-folder-mailbox-internal folder))
1222     (setq candidates
1223           (elmo-imap4-response-value
1224            (elmo-imap4-send-command-wait session
1225                                          (list
1226                                           (if elmo-imap4-use-uid
1227                                               "uid search header message-id "
1228                                             "search header message-id ")
1229                                           (elmo-imap4-field-body msgid)))
1230            'search))
1231     (if (memq number candidates)
1232         (elmo-folder-delete-messages folder (list number)))))
1233
1234 (defun elmo-imap4-server-diff-async-callback-1 (status data)
1235   (funcall elmo-imap4-server-diff-async-callback
1236            (list (elmo-imap4-response-value status 'recent)
1237                  (elmo-imap4-response-value status 'unseen)
1238                  (elmo-imap4-response-value status 'messages))
1239            data))
1240
1241 (defun elmo-imap4-server-diff-async (folder)
1242   (let ((session (elmo-imap4-get-session folder)))
1243     ;; We should `check' folder to obtain newest information here.
1244     ;; But since there's no asynchronous check mechanism in elmo yet,
1245     ;; checking is not done here.
1246     (with-current-buffer (elmo-network-session-buffer session)
1247       (setq elmo-imap4-status-callback
1248             'elmo-imap4-server-diff-async-callback-1)
1249       (setq elmo-imap4-status-callback-data
1250             elmo-imap4-server-diff-async-callback-data))
1251     (elmo-imap4-send-command session
1252                              (list
1253                               "status "
1254                               (elmo-imap4-mailbox
1255                                (elmo-imap4-folder-mailbox-internal folder))
1256                               " (recent unseen messages)"))))
1257
1258 (luna-define-method elmo-server-diff-async ((folder elmo-imap4-folder))
1259   (let ((session (elmo-imap4-get-session folder)))
1260 ;;;    ;; commit.
1261 ;;;    (elmo-imap4-commit spec)
1262     (with-current-buffer (elmo-network-session-buffer session)
1263       (setq elmo-imap4-status-callback
1264             'elmo-imap4-server-diff-async-callback-1)
1265       (setq elmo-imap4-status-callback-data
1266             elmo-imap4-server-diff-async-callback-data))
1267     (elmo-imap4-send-command session
1268                              (list
1269                               "status "
1270                               (elmo-imap4-mailbox
1271                                (elmo-imap4-folder-mailbox-internal folder))
1272                               " (recent unseen messages)"))))
1273
1274 ;;; IMAP parser.
1275
1276 (defvar elmo-imap4-server-eol "\r\n"
1277   "The EOL string sent from the server.")
1278
1279 (defvar elmo-imap4-client-eol "\r\n"
1280   "The EOL string we send to the server.")
1281
1282 (defvar elmo-imap4-literal-progress-reporter nil)
1283
1284 (defun elmo-imap4-find-next-line ()
1285   "Return point at end of current line, taking into account literals.
1286 Return nil if no complete line has arrived."
1287   (when (re-search-forward (concat elmo-imap4-server-eol "\\|{\\([0-9]+\\)}"
1288                                    elmo-imap4-server-eol)
1289                            nil t)
1290     (if (match-string 1)
1291         (if (< (point-max) (+ (point) (string-to-number (match-string 1))))
1292             (progn
1293               (when elmo-imap4-literal-progress-reporter
1294                 (elmo-progress-notify
1295                  'elmo-retrieve-message
1296                  :set (- (point-max) (point))
1297                  :total (string-to-number (match-string 1))))
1298               nil)
1299           (goto-char (+ (point) (string-to-number (match-string 1))))
1300           (elmo-imap4-find-next-line))
1301       (point))))
1302
1303 (defun elmo-imap4-sentinel (process string)
1304   (delete-process process))
1305
1306 (defun elmo-imap4-arrival-filter (proc string)
1307   "IMAP process filter."
1308   (when (buffer-live-p (process-buffer proc))
1309   (with-current-buffer (process-buffer proc)
1310     (goto-char (point-max))
1311     (insert string)
1312     (let (end)
1313       (goto-char (point-min))
1314       (while (setq end (elmo-imap4-find-next-line))
1315         (save-restriction
1316           (narrow-to-region (point-min) end)
1317           (delete-char (- (length elmo-imap4-server-eol)))
1318           (goto-char (point-min))
1319           (unwind-protect
1320               (case elmo-imap4-status
1321                 (initial
1322                  (setq elmo-imap4-current-response
1323                        (list
1324                         (list 'greeting (elmo-imap4-parse-greeting)))))
1325                 ((auth nonauth selected examine)
1326                  (setq elmo-imap4-current-response
1327                        (cons (elmo-imap4-parse-response)
1328                              elmo-imap4-current-response)))
1329                 (t
1330                  (message "Unknown state %s in arrival filter"
1331                           elmo-imap4-status)))
1332             (delete-region (point-min) (point-max)))))))))
1333
1334 ;; IMAP parser.
1335
1336 (defsubst elmo-imap4-forward ()
1337   (or (eobp) (forward-char 1)))
1338
1339 (defsubst elmo-imap4-parse-number ()
1340   (when (looking-at "[0-9]+")
1341     (prog1
1342         (string-to-number (match-string 0))
1343       (goto-char (match-end 0)))))
1344
1345 (defsubst elmo-imap4-parse-literal ()
1346   (when (looking-at "{\\([0-9]+\\)}\r\n")
1347     (let ((pos (match-end 0))
1348           (len (string-to-number (match-string 1))))
1349       (if (< (point-max) (+ pos len))
1350           nil
1351         (goto-char (+ pos len))
1352         (buffer-substring pos (+ pos len))))))
1353 ;;;     (list ' pos (+ pos len))))))
1354
1355 (defsubst elmo-imap4-parse-string ()
1356   (cond ((eq (char-after (point)) ?\")
1357          (forward-char 1)
1358          (let ((p (point)) (name ""))
1359            (skip-chars-forward "^\"\\\\")
1360            (setq name (buffer-substring p (point)))
1361            (while (eq (char-after (point)) ?\\)
1362              (setq p (1+ (point)))
1363              (forward-char 2)
1364              (skip-chars-forward "^\"\\\\")
1365              (setq name (concat name (buffer-substring p (point)))))
1366            (forward-char 1)
1367            name))
1368         ((eq (char-after (point)) ?{)
1369          (elmo-imap4-parse-literal))))
1370
1371 (defsubst elmo-imap4-parse-nil ()
1372   (if (looking-at "NIL")
1373       (goto-char (match-end 0))))
1374
1375 (defsubst elmo-imap4-parse-nstring ()
1376   (or (elmo-imap4-parse-string)
1377       (and (elmo-imap4-parse-nil)
1378            nil)))
1379
1380 (defsubst elmo-imap4-parse-astring ()
1381   (or (elmo-imap4-parse-string)
1382       (buffer-substring (point)
1383                         (if (re-search-forward "[(){ \r\n%*\"\\]" nil t)
1384                             (goto-char (1- (match-end 0)))
1385                           (end-of-line)
1386                           (point)))))
1387
1388 (defsubst elmo-imap4-parse-address ()
1389   (let (address)
1390     (when (eq (char-after (point)) ?\()
1391       (elmo-imap4-forward)
1392       (setq address (vector (prog1 (elmo-imap4-parse-nstring)
1393                               (elmo-imap4-forward))
1394                             (prog1 (elmo-imap4-parse-nstring)
1395                               (elmo-imap4-forward))
1396                             (prog1 (elmo-imap4-parse-nstring)
1397                               (elmo-imap4-forward))
1398                             (elmo-imap4-parse-nstring)))
1399       (when (eq (char-after (point)) ?\))
1400         (elmo-imap4-forward)
1401         address))))
1402
1403 (defsubst elmo-imap4-parse-address-list ()
1404   (if (eq (char-after (point)) ?\()
1405       (let (address addresses)
1406         (elmo-imap4-forward)
1407         (while (and (not (eq (char-after (point)) ?\)))
1408                     ;; next line for MS Exchange bug
1409                     (progn (and (eq (char-after (point)) (string-to-char " "))
1410                                 (elmo-imap4-forward)) t)
1411                     (setq address (elmo-imap4-parse-address)))
1412           (setq addresses (cons address addresses)))
1413         (when (eq (char-after (point)) ?\))
1414           (elmo-imap4-forward)
1415           (nreverse addresses)))
1416     (assert (elmo-imap4-parse-nil))))
1417
1418 (defsubst elmo-imap4-parse-mailbox ()
1419   (let ((mailbox (elmo-imap4-parse-astring)))
1420     (if (string-equal "INBOX" (upcase mailbox))
1421         "INBOX"
1422       mailbox)))
1423
1424 (defun elmo-imap4-parse-greeting ()
1425   "Parse a IMAP greeting."
1426   (cond ((looking-at "\\* OK ")
1427          (setq elmo-imap4-status 'nonauth))
1428         ((looking-at "\\* PREAUTH ")
1429          (setq elmo-imap4-status 'auth))
1430         ((looking-at "\\* BYE ")
1431          (setq elmo-imap4-status 'closed))))
1432
1433 (defun elmo-imap4-parse-response ()
1434   "Parse a IMAP command response."
1435   (elmo-imap4-debug "[%s] -> %s" (format-time-string "%T") (buffer-substring (point) (point-max)))
1436   (let (token)
1437     (case (setq token (read (current-buffer)))
1438       (+ (progn
1439            (skip-chars-forward " ")
1440            (list 'continue-req (buffer-substring (point) (point-max)))))
1441       (* (case (prog1 (setq token (read (current-buffer)))
1442                  (elmo-imap4-forward))
1443            (OK         (elmo-imap4-parse-resp-text-code))
1444            (NO         (elmo-imap4-parse-resp-text-code))
1445            (BAD        (elmo-imap4-parse-resp-text-code))
1446            (BYE        (elmo-imap4-parse-bye))
1447            (FLAGS      (list 'flags
1448                              (elmo-imap4-parse-flag-list)))
1449            (LIST       (list 'list (elmo-imap4-parse-data-list)))
1450            (LSUB       (list 'lsub (elmo-imap4-parse-data-list)))
1451            (SEARCH     (list
1452                         'search
1453                         (read (concat "("
1454                                       (buffer-substring (point) (point-max))
1455                                       ")"))))
1456            (ESEARCH     (list
1457                          'esearch
1458                          (cddr (split-string (buffer-substring (point) (point-max)) " "))))
1459            (STATUS     (elmo-imap4-parse-status))
1460            ;; Added
1461            (NAMESPACE  (elmo-imap4-parse-namespace))
1462            (CAPABILITY (list 'capability
1463                              (read
1464                               (concat "(" (downcase (buffer-substring
1465                                                      (point) (point-max)))
1466                                       ")"))))
1467            (ACL (elmo-imap4-parse-acl))
1468            (t       (case (prog1 (read (current-buffer))
1469                             (elmo-imap4-forward))
1470                       (EXISTS  (list 'exists token))
1471                       (RECENT  (list 'recent token))
1472                       (EXPUNGE (list 'expunge token))
1473                       (FETCH   (elmo-imap4-parse-fetch token))
1474                       (t       (list 'garbage (buffer-string)))))))
1475       (t (if (not (string-match elmo-imap4-seq-prefix (symbol-name token)))
1476              (list 'garbage (buffer-string))
1477            (case (prog1 (read (current-buffer))
1478                    (elmo-imap4-forward))
1479              (OK  (progn
1480                     (setq elmo-imap4-parsing nil)
1481                     (setq token (symbol-name token))
1482                     (elmo-unintern token)
1483                     (elmo-imap4-debug "*%s* OK arrived" token)
1484                     (setq elmo-imap4-reached-tag token)
1485                     (list 'ok (elmo-imap4-parse-resp-text-code))))
1486              (NO  (progn
1487                     (setq elmo-imap4-parsing nil)
1488                     (setq token (symbol-name token))
1489                     (elmo-unintern token)
1490                     (elmo-imap4-debug "*%s* NO arrived" token)
1491                     (setq elmo-imap4-reached-tag token)
1492                     (let (code text)
1493                       (when (eq (char-after (point)) ?\[)
1494                         (setq code (buffer-substring (point)
1495                                                      (search-forward "]")))
1496                         (elmo-imap4-forward))
1497                       (setq text (buffer-substring (point) (point-max)))
1498                       (list 'no (list code text)))))
1499              (BAD (progn
1500                     (setq elmo-imap4-parsing nil)
1501                     (elmo-imap4-debug "*%s* BAD arrived" token)
1502                     (setq token (symbol-name token))
1503                     (elmo-unintern token)
1504                     (setq elmo-imap4-reached-tag token)
1505                     (let (code text)
1506                       (when (eq (char-after (point)) ?\[)
1507                         (setq code (buffer-substring (point)
1508                                                      (search-forward "]")))
1509                         (elmo-imap4-forward))
1510                       (setq text (buffer-substring (point) (point-max)))
1511                       (list 'bad (list code text)))))
1512              (t   (list 'garbage (buffer-string)))))))))
1513
1514 (defun elmo-imap4-parse-bye ()
1515   (let (code text)
1516     (when (eq (char-after (point)) ?\[)
1517       (setq code (buffer-substring (point)
1518                                    (search-forward "]")))
1519       (elmo-imap4-forward))
1520     (setq text (buffer-substring (point) (point-max)))
1521     (list 'bye (list code text))))
1522
1523 (defun elmo-imap4-parse-text ()
1524   (goto-char (point-min))
1525   (when (search-forward "[" nil t)
1526     (search-forward "]")
1527     (elmo-imap4-forward))
1528   (list 'text (buffer-substring (point) (point-max))))
1529
1530 (defun elmo-imap4-parse-resp-text-code ()
1531   (when (eq (char-after (point)) ?\[)
1532     (elmo-imap4-forward)
1533     (cond ((search-forward "PERMANENTFLAGS " nil t)
1534            (list 'permanentflags (elmo-imap4-parse-flag-list)))
1535           ((search-forward "UIDNEXT " nil t)
1536            (list 'uidnext (read (current-buffer))))
1537           ((search-forward "UNSEEN " nil t)
1538            (list 'unseen (read (current-buffer))))
1539           ((looking-at "UIDVALIDITY \\([0-9]+\\)")
1540            (list 'uidvalidity (match-string 1)))
1541           ((search-forward "READ-ONLY" nil t)
1542            (list 'read-only t))
1543           ((search-forward "READ-WRITE" nil t)
1544            (list 'read-write t))
1545           ((search-forward "NEWNAME " nil t)
1546            (let (oldname newname)
1547              (setq oldname (elmo-imap4-parse-string))
1548              (elmo-imap4-forward)
1549              (setq newname (elmo-imap4-parse-string))
1550              (list 'newname newname oldname)))
1551           ((search-forward "TRYCREATE" nil t)
1552            (list 'trycreate t))
1553           ((looking-at "APPENDUID \\([0-9]+\\) \\([0-9]+\\)")
1554            (list 'appenduid
1555                  (list (match-string 1)
1556                        (string-to-number (match-string 2)))))
1557           ((looking-at "COPYUID \\([0-9]+\\) \\([0-9,:]+\\) \\([0-9,:]+\\)")
1558            (list 'copyuid (list (match-string 1)
1559                                 (match-string 2)
1560                                 (match-string 3))))
1561           ((search-forward "ALERT] " nil t)
1562            (message "IMAP server information: %s"
1563                     (buffer-substring (point) (point-max))))
1564           (t (list 'unknown)))))
1565
1566 (defun elmo-imap4-parse-data-list ()
1567   (let (flags delimiter mailbox)
1568     (setq flags (elmo-imap4-parse-flag-list))
1569     (when (looking-at " NIL\\| \"\\\\?\\(.\\)\"")
1570       (setq delimiter (match-string 1))
1571       (goto-char (1+ (match-end 0)))
1572       (when (setq mailbox (elmo-imap4-parse-mailbox))
1573         (list mailbox flags delimiter)))))
1574
1575 (defsubst elmo-imap4-parse-header-list ()
1576   (when (eq (char-after (point)) ?\()
1577     (let (strlist)
1578       (while (not (eq (char-after (point)) ?\)))
1579         (elmo-imap4-forward)
1580         (push (elmo-imap4-parse-astring) strlist))
1581       (elmo-imap4-forward)
1582       (nreverse strlist))))
1583
1584 (defsubst elmo-imap4-parse-fetch-body-section ()
1585   (let ((section
1586          (buffer-substring (point)
1587                            (1-
1588                             (progn (re-search-forward "[] ]" nil t)
1589                                    (point))))))
1590     (if (eq (char-before) (string-to-char " "))
1591         (prog1
1592             (mapconcat 'identity
1593                        (cons section (elmo-imap4-parse-header-list)) " ")
1594           (search-forward "]" nil t))
1595       section)))
1596
1597 (defun elmo-imap4-parse-fetch (response)
1598   (when (eq (char-after (point)) ?\()
1599     (let (element list)
1600       (while (not (eq (char-after (point)) ?\)))
1601         (elmo-imap4-forward)
1602         (let ((token (read (current-buffer))))
1603           (elmo-imap4-forward)
1604           (setq element
1605                 (cond ((eq token 'UID)
1606                        (list 'uid (condition-case nil
1607                                       (read (current-buffer))
1608                                     (error nil))))
1609                       ((eq token 'FLAGS)
1610                        (list 'flags (elmo-imap4-parse-flag-list)))
1611                       ((eq token 'ENVELOPE)
1612                        (list 'envelope (elmo-imap4-parse-envelope)))
1613                       ((eq token 'INTERNALDATE)
1614                        (list 'internaldate (elmo-imap4-parse-string)))
1615                       ((eq token 'RFC822)
1616                        (list 'rfc822 (elmo-imap4-parse-nstring)))
1617                       ((eq token (intern elmo-imap4-rfc822-header))
1618                        (list 'rfc822header (elmo-imap4-parse-nstring)))
1619                       ((eq token (intern elmo-imap4-rfc822-text))
1620                        (list 'rfc822text (elmo-imap4-parse-nstring)))
1621                       ((eq token (intern elmo-imap4-rfc822-size))
1622                        (list 'rfc822size (read (current-buffer))))
1623                       ((eq token 'BODY)
1624                        (if (eq (char-before) ?\[)
1625                            (list
1626                             'bodydetail
1627                             (upcase (elmo-imap4-parse-fetch-body-section))
1628                             (and
1629                              (eq (char-after (point)) ?<)
1630                              (buffer-substring (1+ (point))
1631                                                (progn
1632                                                  (search-forward ">" nil t)
1633                                                  (point))))
1634                             (progn (elmo-imap4-forward)
1635                                    (elmo-imap4-parse-nstring)))
1636                          (list 'body (elmo-imap4-parse-body))))
1637                       ((eq token 'BODYSTRUCTURE)
1638                        (list 'bodystructure (elmo-imap4-parse-body)))))
1639           (setq list (cons element list))))
1640       (and elmo-imap4-fetch-callback
1641            (funcall elmo-imap4-fetch-callback
1642                     list elmo-imap4-fetch-callback-data))
1643       (list 'fetch list))))
1644
1645 (defun elmo-imap4-parse-status ()
1646   (let ((mailbox (elmo-imap4-parse-mailbox))
1647         status)
1648     (when (and mailbox (search-forward "(" nil t))
1649       (while (not (eq (char-after (point)) ?\)))
1650         (setq status
1651               (cons
1652                (let ((token (read (current-buffer))))
1653                  (case (intern (upcase (symbol-name token)))
1654                    (MESSAGES
1655                     (list 'messages (read (current-buffer))))
1656                    (RECENT
1657                     (list 'recent (read (current-buffer))))
1658                    (UIDNEXT
1659                     (list 'uidnext (read (current-buffer))))
1660                    (UIDVALIDITY
1661                     (and (looking-at " \\([0-9]+\\)")
1662                          (prog1 (list 'uidvalidity (match-string 1))
1663                            (goto-char (match-end 1)))))
1664                    (UNSEEN
1665                     (list 'unseen (read (current-buffer))))
1666                    (t
1667                     (message
1668                      "Unknown status data %s in mailbox %s ignored"
1669                      token mailbox))))
1670                status))
1671         (skip-chars-forward " ")))
1672     (and elmo-imap4-status-callback
1673          (funcall elmo-imap4-status-callback
1674                   status
1675                   elmo-imap4-status-callback-data))
1676     (list 'status status)))
1677
1678
1679 (defmacro elmo-imap4-value (value)
1680   `(if (eq ,value 'NIL)
1681        nil
1682      ,value))
1683
1684 (defmacro elmo-imap4-nth (pos list)
1685   `(let ((value (nth ,pos ,list)))
1686      (elmo-imap4-value value)))
1687
1688 (defun elmo-imap4-parse-namespace ()
1689   (list 'namespace
1690         (nconc
1691          (copy-sequence elmo-imap4-extra-namespace-alist)
1692          (elmo-imap4-parse-namespace-subr
1693           (read (concat "(" (buffer-substring
1694                              (point) (point-max))
1695                         ")"))))))
1696
1697 (defun elmo-imap4-parse-namespace-subr (ns)
1698   (let (prefix delim namespace-alist default-delim)
1699     ;; 0: personal, 1: other, 2: shared
1700     (dotimes (i 3)
1701       (setq namespace-alist
1702             (nconc namespace-alist
1703                    (delq nil
1704                          (mapcar
1705                           (lambda (namespace)
1706                             (setq prefix (elmo-imap4-nth 0 namespace)
1707                                   delim (elmo-imap4-nth 1 namespace))
1708                             (if (and prefix delim
1709                                      (string-match
1710                                       (concat (regexp-quote delim) "\\'")
1711                                       prefix))
1712                                 (setq prefix (substring prefix 0
1713                                                         (match-beginning 0))))
1714                             (if (eq (length prefix) 0)
1715                                 (progn (setq default-delim delim) nil)
1716                               (cons
1717                                (concat "^\\("
1718                                        (if (string= (downcase prefix) "inbox")
1719                                            "[Ii][Nn][Bb][Oo][Xx]"
1720                                          (regexp-quote prefix))
1721                                        "\\).*$")
1722                                delim)))
1723                           (elmo-imap4-nth i ns))))))
1724     (if default-delim
1725         (setq namespace-alist
1726               (nconc namespace-alist
1727                      (list (cons "^.*$" default-delim)))))
1728     namespace-alist))
1729
1730 (defun elmo-imap4-parse-acl ()
1731   (let ((mailbox (elmo-imap4-parse-mailbox))
1732         identifier rights acl)
1733     (while (eq (char-after (point)) (string-to-char " "))
1734       (elmo-imap4-forward)
1735       (setq identifier (elmo-imap4-parse-astring))
1736       (elmo-imap4-forward)
1737       (setq rights (elmo-imap4-parse-astring))
1738       (setq acl (append acl (list (cons identifier rights)))))
1739     (list 'acl acl mailbox)))
1740
1741 (defun elmo-imap4-parse-flag-list ()
1742   (let ((str (buffer-substring (+ (point) 1)
1743                                (progn (search-forward ")" nil t)
1744                                       (- (point) 1)))))
1745     (unless (eq (length str) 0)
1746       (split-string str))))
1747
1748 (defun elmo-imap4-parse-envelope ()
1749   (when (eq (char-after (point)) ?\()
1750     (elmo-imap4-forward)
1751     (vector (prog1 (elmo-imap4-parse-nstring);; date
1752               (elmo-imap4-forward))
1753             (prog1 (elmo-imap4-parse-nstring);; subject
1754               (elmo-imap4-forward))
1755             (prog1 (elmo-imap4-parse-address-list);; from
1756               (elmo-imap4-forward))
1757             (prog1 (elmo-imap4-parse-address-list);; sender
1758               (elmo-imap4-forward))
1759             (prog1 (elmo-imap4-parse-address-list);; reply-to
1760               (elmo-imap4-forward))
1761             (prog1 (elmo-imap4-parse-address-list);; to
1762               (elmo-imap4-forward))
1763             (prog1 (elmo-imap4-parse-address-list);; cc
1764               (elmo-imap4-forward))
1765             (prog1 (elmo-imap4-parse-address-list);; bcc
1766               (elmo-imap4-forward))
1767             (prog1 (elmo-imap4-parse-nstring);; in-reply-to
1768               (elmo-imap4-forward))
1769             (prog1 (elmo-imap4-parse-nstring);; message-id
1770               (elmo-imap4-forward)))))
1771
1772 (defsubst elmo-imap4-parse-string-list ()
1773   (cond ((eq (char-after (point)) ?\();; body-fld-param
1774          (let (strlist str)
1775            (elmo-imap4-forward)
1776            (while (setq str (elmo-imap4-parse-string))
1777              (push str strlist)
1778              (elmo-imap4-forward))
1779            (nreverse strlist)))
1780         ((elmo-imap4-parse-nil)
1781          nil)))
1782
1783 (defun elmo-imap4-parse-body-extension ()
1784   (if (eq (char-after (point)) ?\()
1785       (let (b-e)
1786         (elmo-imap4-forward)
1787         (push (elmo-imap4-parse-body-extension) b-e)
1788         (while (eq (char-after (point)) (string-to-char " "))
1789           (elmo-imap4-forward)
1790           (push (elmo-imap4-parse-body-extension) b-e))
1791         (assert (eq (char-after (point)) ?\)))
1792         (elmo-imap4-forward)
1793         (nreverse b-e))
1794     (or (elmo-imap4-parse-number)
1795         (elmo-imap4-parse-nstring))))
1796
1797 (defsubst elmo-imap4-parse-body-ext ()
1798   (let (ext)
1799     (when (eq (char-after (point)) (string-to-char " ")) ; body-fld-dsp
1800       (elmo-imap4-forward)
1801       (let (dsp)
1802         (if (eq (char-after (point)) ?\()
1803             (progn
1804               (elmo-imap4-forward)
1805               (push (elmo-imap4-parse-string) dsp)
1806               (elmo-imap4-forward)
1807               (push (elmo-imap4-parse-string-list) dsp)
1808               (elmo-imap4-forward))
1809           (assert (elmo-imap4-parse-nil)))
1810         (push (nreverse dsp) ext))
1811       (when (eq (char-after (point)) (string-to-char " ")) ; body-fld-lang
1812         (elmo-imap4-forward)
1813         (if (eq (char-after (point)) ?\()
1814             (push (elmo-imap4-parse-string-list) ext)
1815           (push (elmo-imap4-parse-nstring) ext))
1816         (while (eq (char-after (point)) (string-to-char " "));; body-extension
1817           (elmo-imap4-forward)
1818           (setq ext (append (elmo-imap4-parse-body-extension) ext)))))
1819     ext))
1820
1821 (defun elmo-imap4-parse-body ()
1822   (let (body)
1823     (when (eq (char-after (point)) ?\()
1824       (elmo-imap4-forward)
1825       (if (eq (char-after (point)) ?\()
1826           (let (subbody)
1827             (while (and (eq (char-after (point)) ?\()
1828                         (setq subbody (elmo-imap4-parse-body)))
1829               (push subbody body))
1830             (elmo-imap4-forward)
1831             (push (elmo-imap4-parse-string) body);; media-subtype
1832             (when (eq (char-after (point)) (string-to-char " ")) ; body-ext-mpart:
1833               (elmo-imap4-forward)
1834               (if (eq (char-after (point)) ?\();; body-fld-param
1835                   (push (elmo-imap4-parse-string-list) body)
1836                 (push (and (elmo-imap4-parse-nil) nil) body))
1837               (setq body
1838                     (append (elmo-imap4-parse-body-ext) body)));; body-ext-...
1839             (assert (eq (char-after (point)) ?\)))
1840             (elmo-imap4-forward)
1841             (nreverse body))
1842
1843         (push (elmo-imap4-parse-string) body);; media-type
1844         (elmo-imap4-forward)
1845         (push (elmo-imap4-parse-string) body);; media-subtype
1846         (elmo-imap4-forward)
1847         ;; next line for Sun SIMS bug
1848         (and (eq (char-after (point)) (string-to-char " "))
1849              (elmo-imap4-forward))
1850         (if (eq (char-after (point)) ?\();; body-fld-param
1851             (push (elmo-imap4-parse-string-list) body)
1852           (push (and (elmo-imap4-parse-nil) nil) body))
1853         (elmo-imap4-forward)
1854         (push (elmo-imap4-parse-nstring) body);; body-fld-id
1855         (elmo-imap4-forward)
1856         (push (elmo-imap4-parse-nstring) body);; body-fld-desc
1857         (elmo-imap4-forward)
1858         (push (elmo-imap4-parse-string) body);; body-fld-enc
1859         (elmo-imap4-forward)
1860         (push (elmo-imap4-parse-number) body);; body-fld-octets
1861
1862         ;; ok, we're done parsing the required parts, what comes now is one
1863         ;; of three things:
1864         ;;
1865         ;; envelope       (then we're parsing body-type-msg)
1866         ;; body-fld-lines (then we're parsing body-type-text)
1867         ;; body-ext-1part (then we're parsing body-type-basic)
1868         ;;
1869         ;; the problem is that the two first are in turn optionally followed
1870         ;; by the third.  So we parse the first two here (if there are any)...
1871
1872         (when (eq (char-after (point)) (string-to-char " "))
1873           (elmo-imap4-forward)
1874           (let (lines)
1875             (cond ((eq (char-after (point)) ?\();; body-type-msg:
1876                    (push (elmo-imap4-parse-envelope) body);; envelope
1877                    (elmo-imap4-forward)
1878                    (push (elmo-imap4-parse-body) body);; body
1879                    (elmo-imap4-forward)
1880                    (push (elmo-imap4-parse-number) body));; body-fld-lines
1881                   ((setq lines (elmo-imap4-parse-number));; body-type-text:
1882                    (push lines body));; body-fld-lines
1883                   (t
1884                    (backward-char)))));; no match...
1885
1886         ;; ...and then parse the third one here...
1887
1888         (when (eq (char-after (point)) (string-to-char " ")) ; body-ext-1part:
1889           (elmo-imap4-forward)
1890           (push (elmo-imap4-parse-nstring) body);; body-fld-md5
1891           (setq body
1892                 (append (elmo-imap4-parse-body-ext) body)));; body-ext-1part..
1893
1894         (assert (eq (char-after (point)) ?\)))
1895         (elmo-imap4-forward)
1896         (nreverse body)))))
1897
1898 (luna-define-method elmo-folder-initialize ((folder elmo-imap4-folder) name)
1899   (let ((default-user   elmo-imap4-default-user)
1900         (default-server elmo-imap4-default-server)
1901         (default-port   elmo-imap4-default-port)
1902         (elmo-network-stream-type-alist
1903          (if elmo-imap4-stream-type-alist
1904              (append elmo-imap4-stream-type-alist
1905                      elmo-network-stream-type-alist)
1906            elmo-network-stream-type-alist))
1907         tokens)
1908     (when (string-match "\\(.*\\)@\\(.*\\)" default-server)
1909       ;; case: imap4-default-server is specified like
1910       ;; "hoge%imap.server@gateway".
1911       (setq default-user (elmo-match-string 1 default-server))
1912       (setq default-server (elmo-match-string 2 default-server)))
1913     (setq tokens (car (elmo-parse-separated-tokens
1914                        name
1915                        elmo-imap4-folder-name-syntax)))
1916     ;; mailbox
1917     (elmo-imap4-folder-set-mailbox-internal folder
1918                                             (elmo-imap4-encode-folder-string
1919                                              (cdr (assq 'mailbox tokens))))
1920     ;; user
1921     (elmo-net-folder-set-user-internal folder
1922                                        (or (cdr (assq 'user tokens))
1923                                            default-user))
1924     ;; auth
1925     (elmo-net-folder-set-auth-internal
1926      folder
1927      (let ((auth (cdr (assq 'auth tokens))))
1928        (or (and auth (intern auth))
1929            elmo-imap4-default-authenticate-type
1930            'clear)))
1931     ;; network
1932     (elmo-net-folder-set-parameters
1933      folder
1934      tokens
1935      (list :server      default-server
1936            :port        default-port
1937            :stream-type
1938            (elmo-get-network-stream-type elmo-imap4-default-stream-type)))
1939     folder))
1940
1941 ;;; ELMO IMAP4 folder
1942 (luna-define-method elmo-folder-expand-msgdb-path ((folder
1943                                                     elmo-imap4-folder))
1944   (convert-standard-filename
1945    (let ((mailbox (elmo-imap4-folder-mailbox-internal folder)))
1946      (if (string= "inbox" (downcase mailbox))
1947          (setq mailbox "inbox"))
1948      (if (eq (string-to-char mailbox) ?/)
1949          (setq mailbox (substring mailbox 1 (length mailbox))))
1950      ;; don't use expand-file-name (e.g. %~/something)
1951      (concat
1952       (expand-file-name
1953        (or (elmo-net-folder-user-internal folder) "nobody")
1954        (expand-file-name (or (elmo-net-folder-server-internal folder)
1955                              "nowhere")
1956                          (expand-file-name
1957                           "imap"
1958                           elmo-msgdb-directory)))
1959       "/" mailbox))))
1960
1961 (luna-define-method elmo-folder-status-plugged ((folder
1962                                                  elmo-imap4-folder))
1963   (elmo-imap4-folder-status-plugged folder))
1964
1965 (defun elmo-imap4-folder-status-plugged (folder)
1966   (let ((session (elmo-imap4-get-session folder))
1967         (killed (elmo-msgdb-killed-list-load
1968                  (elmo-folder-msgdb-path folder)))
1969         status)
1970     (with-current-buffer (elmo-network-session-buffer session)
1971       (setq elmo-imap4-status-callback nil)
1972       (setq elmo-imap4-status-callback-data nil))
1973     (setq status (elmo-imap4-response-value
1974                   (elmo-imap4-send-command-wait
1975                    session
1976                    (list "status "
1977                          (elmo-imap4-mailbox
1978                           (elmo-imap4-folder-mailbox-internal folder))
1979                          " (uidnext messages)"))
1980                   'status))
1981     (cons
1982      (- (elmo-imap4-response-value status 'uidnext) 1)
1983      (if killed
1984          (-
1985           (elmo-imap4-response-value status 'messages)
1986           (elmo-msgdb-killed-list-length killed))
1987        (elmo-imap4-response-value status 'messages)))))
1988
1989 (defun elmo-imap4-folder-list-range (folder min max)
1990   (elmo-imap4-list
1991    folder
1992    (concat
1993     (let ((killed (elmo-folder-killed-list-internal folder)))
1994       (if (and killed
1995                (eq (length killed) 1)
1996                (consp (car killed))
1997                (eq (car (car killed)) 1))
1998           ;; What about elmo-imap4-use-uid?
1999           (format "uid %d:%s" (cdr (car killed)) max)
2000         (format "uid %s:%s" min max)))
2001     " undeleted")))
2002
2003 (luna-define-method elmo-folder-list-messages-plugged
2004   ((folder elmo-imap4-folder) &optional enable-killed)
2005   (let* ((old (elmo-msgdb-list-messages (elmo-folder-msgdb folder)))
2006          (new (elmo-imap4-folder-list-range
2007                folder (1+ (or (elmo-folder-get-info-max folder) 0)) "*"))
2008          (united-old-new (elmo-union old new)))
2009     (if (= (length united-old-new) (or (elmo-folder-get-info-length folder) 0))
2010         united-old-new
2011       (elmo-union new
2012                   (elmo-imap4-folder-list-range
2013                    folder
2014                    1 (1+ (or (elmo-folder-get-info-max folder) 0)))))))
2015
2016 (luna-define-method elmo-folder-list-flagged-plugged
2017   ((folder elmo-imap4-folder) flag)
2018   (elmo-imap4-folder-list-flagged folder flag))
2019
2020 (luna-define-method elmo-folder-use-flag-p ((folder elmo-imap4-folder))
2021   (not (string-match elmo-imap4-disuse-server-flag-mailbox-regexp
2022                      (elmo-imap4-folder-mailbox-internal folder))))
2023
2024 (luna-define-method elmo-folder-list-subfolders ((folder elmo-imap4-folder)
2025                                                  &optional one-level)
2026   (let* ((root (elmo-imap4-folder-mailbox-internal folder))
2027          (session (elmo-imap4-get-session folder))
2028          (prefix (elmo-folder-prefix-internal folder))
2029          (namespace-assoc
2030                   (elmo-string-matched-assoc
2031                    root
2032                    (with-current-buffer (elmo-network-session-buffer session)
2033                      elmo-imap4-server-namespace)))
2034          (delim (or (cdr namespace-assoc)
2035                  elmo-imap4-default-hierarchy-delimiter))
2036          ;; Append delimiter when root with namespace.
2037          (root-nodelim root)
2038          (root (if (and namespace-assoc
2039                         (match-end 1)
2040                         (string= (substring root (match-end 1))
2041                                  ""))
2042                    (concat root delim)
2043                  root))
2044          result append-serv type)
2045     (setq result (elmo-imap4-response-get-selectable-mailbox-list
2046                   (elmo-imap4-send-command-wait
2047                    session
2048                    (list "list " (elmo-imap4-mailbox root) " *"))))
2049     ;; The response of Courier-imap doesn't contain a specified folder itself.
2050     (unless (member root result)
2051       (setq result
2052             (append result
2053                     (elmo-imap4-response-get-selectable-mailbox-list
2054                      (elmo-imap4-send-command-wait
2055                       session
2056                       (list "list \"\" " (elmo-imap4-mailbox
2057                                           root-nodelim)))))))
2058     (when (or (not (string= (elmo-net-folder-user-internal folder)
2059                             elmo-imap4-default-user))
2060               (not (eq (elmo-net-folder-auth-internal folder)
2061                        (or elmo-imap4-default-authenticate-type 'clear))))
2062       (setq append-serv (concat ":"
2063                                 (elmo-quote-syntactical-element
2064                                  (elmo-net-folder-user-internal folder)
2065                                  'user elmo-imap4-folder-name-syntax))))
2066     (unless (eq (elmo-net-folder-auth-internal folder)
2067                 (or elmo-imap4-default-authenticate-type 'clear))
2068       (setq append-serv
2069             (concat append-serv "/"
2070                     (symbol-name (elmo-net-folder-auth-internal folder)))))
2071     (unless (string= (elmo-net-folder-server-internal folder)
2072                      elmo-imap4-default-server)
2073       (setq append-serv (concat append-serv "@"
2074                                 (elmo-net-folder-server-internal folder))))
2075     (unless (eq (elmo-net-folder-port-internal folder) elmo-imap4-default-port)
2076       (setq append-serv (concat append-serv ":"
2077                                 (number-to-string
2078                                  (elmo-net-folder-port-internal folder)))))
2079     (setq type (elmo-net-folder-stream-type-internal folder))
2080     (unless (eq (elmo-network-stream-type-symbol type)
2081                 elmo-imap4-default-stream-type)
2082       (if type
2083           (setq append-serv (concat append-serv
2084                                     (elmo-network-stream-type-spec-string
2085                                      type)))))
2086     (if one-level
2087         (let ((re-delim (regexp-quote delim))
2088               (case-fold-search nil)
2089               folder ret has-child-p)
2090           ;; Append delimiter
2091           (when (and root
2092                      (not (string= root ""))
2093                      (not (string-match
2094                            (concat "\\(.*\\)" re-delim "\\'")
2095                            root)))
2096             (setq root (concat root delim)))
2097           (while (setq folder (car result))
2098             (setq has-child-p
2099                   (when (string-match
2100                          (concat "^\\(" (regexp-quote root) "[^" re-delim "]" "+\\)"
2101                                  re-delim)
2102                          folder)
2103                     (setq folder (match-string 1 folder))))
2104             (setq result (delq
2105                           nil
2106                           (mapcar (lambda (fld)
2107                                     (if (string-match
2108                                          (concat "^" (regexp-quote folder)
2109                                                  "\\(" re-delim "\\|\\'\\)")
2110                                          fld)
2111                                         (progn (setq has-child-p t) nil)
2112                                       fld))
2113                                   (cdr result)))
2114                   folder (concat prefix
2115                                  (elmo-quote-syntactical-element
2116                                   (elmo-imap4-decode-folder-string folder)
2117                                   'mailbox elmo-imap4-folder-name-syntax)
2118                                  (and append-serv
2119                                       (eval append-serv)))
2120                   ret (append ret (if has-child-p
2121                                       (list (list folder))
2122                                     (list folder)))))
2123           ret)
2124       (mapcar (lambda (fld)
2125                 (concat prefix
2126                         (elmo-quote-syntactical-element
2127                          (elmo-imap4-decode-folder-string fld)
2128                          'mailbox elmo-imap4-folder-name-syntax)
2129                         (and append-serv
2130                              (eval append-serv))))
2131               result))))
2132
2133 (luna-define-method elmo-folder-exists-p-plugged ((folder elmo-imap4-folder))
2134   (let ((session (elmo-imap4-get-session folder)))
2135     (if (string=
2136          (elmo-imap4-session-current-mailbox-internal session)
2137          (elmo-imap4-folder-mailbox-internal folder))
2138         t
2139       (elmo-imap4-session-select-mailbox
2140        session
2141        (elmo-imap4-folder-mailbox-internal folder)
2142        'force 'notify-bye))))
2143
2144 (luna-define-method elmo-folder-creatable-p ((folder elmo-imap4-folder))
2145   t)
2146
2147 (luna-define-method elmo-folder-writable-p ((folder elmo-imap4-folder))
2148   t)
2149
2150 (luna-define-method elmo-folder-delete ((folder elmo-imap4-folder))
2151   (let* ((exists (elmo-folder-exists-p folder))
2152          (msgs (and exists
2153                     (elmo-folder-list-messages folder))))
2154     (when (yes-or-no-p (format "%sDelete msgdb and substance of \"%s\"? "
2155                                (if (> (length msgs) 0)
2156                                    (format "%d msg(s) exists. " (length msgs))
2157                                  "")
2158                                (elmo-folder-name-internal folder)))
2159       (let ((session (elmo-imap4-get-session folder)))
2160         (when (elmo-imap4-folder-mailbox-internal folder)
2161           (when msgs (elmo-folder-delete-messages-internal folder msgs))
2162           ;; close selected mailbox except one with \Noselect attribute
2163           (when exists
2164             (elmo-imap4-send-command-wait session "close"))
2165           (elmo-imap4-send-command-wait
2166            session
2167            (list "delete "
2168                  (elmo-imap4-mailbox
2169                   (elmo-imap4-folder-mailbox-internal folder)))))
2170         (elmo-imap4-session-set-current-mailbox-internal session nil))
2171       (elmo-msgdb-delete-path folder)
2172       t)))
2173
2174 (luna-define-method elmo-folder-rename-internal ((folder elmo-imap4-folder)
2175                                                  new-folder)
2176   (let ((session (elmo-imap4-get-session folder)))
2177     ;; make sure the folder is selected.
2178     (elmo-imap4-session-select-mailbox session
2179                                        (elmo-imap4-folder-mailbox-internal
2180                                         folder))
2181     (elmo-imap4-send-command-wait session "close")
2182     (elmo-imap4-send-command-wait
2183      session
2184      (list "rename "
2185            (elmo-imap4-mailbox
2186             (elmo-imap4-folder-mailbox-internal folder))
2187            " "
2188            (elmo-imap4-mailbox
2189             (elmo-imap4-folder-mailbox-internal new-folder))))
2190     (elmo-imap4-session-set-current-mailbox-internal
2191      session (elmo-imap4-folder-mailbox-internal new-folder))))
2192
2193 (defun elmo-imap4-copy-messages (src-folder dst-folder numbers)
2194   (let ((session (elmo-imap4-get-session src-folder))
2195         (set-list (elmo-imap4-make-number-set-list
2196                    numbers
2197                    elmo-imap4-number-set-chop-length))
2198         succeeds)
2199     (elmo-imap4-session-select-mailbox session
2200                                        (elmo-imap4-folder-mailbox-internal
2201                                         src-folder))
2202     (while set-list
2203       (if (elmo-imap4-send-command-wait session
2204                                         (list
2205                                          (format
2206                                           (if elmo-imap4-use-uid
2207                                               "uid copy %s "
2208                                             "copy %s ")
2209                                           (cdr (car set-list)))
2210                                          (elmo-imap4-mailbox
2211                                           (elmo-imap4-folder-mailbox-internal
2212                                            dst-folder))))
2213           (setq succeeds (append succeeds numbers)))
2214       (setq set-list (cdr set-list)))
2215     succeeds))
2216
2217 (defun elmo-imap4-set-flag (folder numbers flag &optional remove)
2218   "Set flag on messages.
2219 FOLDER is the ELMO folder structure.
2220 NUMBERS is the message numbers to be flagged.
2221 FLAG is the flag name.
2222 If optional argument REMOVE is non-nil, remove FLAG."
2223   (let ((session (elmo-imap4-get-session folder))
2224         response set-list)
2225     (elmo-imap4-session-select-mailbox session
2226                                        (elmo-imap4-folder-mailbox-internal
2227                                         folder))
2228     (when (or (elmo-string-member-ignore-case
2229                flag
2230                (elmo-imap4-session-flags-internal session))
2231               (member "\\*" (elmo-imap4-session-flags-internal session))
2232               (string= flag "\\Deleted")) ; XXX Humm..
2233       (setq set-list (elmo-imap4-make-number-set-list
2234                       numbers
2235                       elmo-imap4-number-set-chop-length))
2236       (while set-list
2237         (with-current-buffer (elmo-network-session-buffer session)
2238           (setq elmo-imap4-fetch-callback nil)
2239           (setq elmo-imap4-fetch-callback-data nil))
2240         (unless (elmo-imap4-response-ok-p
2241                  (elmo-imap4-send-command-wait
2242                   session
2243                   (format
2244                    (if elmo-imap4-use-uid
2245                        "uid store %s %sflags.silent (%s)"
2246                      "store %s %sflags.silent (%s)")
2247                    (cdr (car set-list))
2248                    (if remove "-" "+")
2249                    flag)))
2250           (setq response 'fail))
2251         (setq set-list (cdr set-list)))
2252       (not (eq response 'fail)))))
2253
2254 (luna-define-method elmo-folder-delete-messages-plugged
2255   ((folder elmo-imap4-folder) numbers)
2256   (let ((session (elmo-imap4-get-session folder))
2257         (expunge
2258          (or (null (elmo-imap4-list folder "deleted"))
2259              (y-or-n-p
2260               "There's hidden deleted messages, expunge anyway?"))))
2261     (elmo-imap4-session-select-mailbox
2262      session
2263      (elmo-imap4-folder-mailbox-internal folder))
2264     (unless (elmo-imap4-set-flag folder numbers "\\Deleted")
2265       (error "Failed to set deleted flag"))
2266     (when expunge
2267       (elmo-imap4-send-command session "expunge"))
2268     t))
2269
2270 (defun elmo-imap4-detect-search-charset (string)
2271   (with-temp-buffer
2272     (insert string)
2273     (detect-mime-charset-region (point-min) (point-max))))
2274
2275 (defun elmo-imap4-search-internal-primitive (folder session filter from-msgs)
2276   (let ((search-key (elmo-filter-key filter))
2277         (imap-search-keys '("bcc" "body" "cc" "from" "subject" "to"
2278                             "larger" "smaller" "flag"))
2279         (total 0)
2280         (length (length from-msgs))
2281         charset set-list end results)
2282     (cond
2283      ((string= "last" search-key)
2284       (let ((numbers (or from-msgs (elmo-folder-list-messages folder))))
2285         (nthcdr (max (- (length numbers)
2286                         (string-to-number (elmo-filter-value filter)))
2287                      0)
2288                 numbers)))
2289      ((string= "first" search-key)
2290       (let* ((numbers (or from-msgs (elmo-folder-list-messages folder)))
2291              (rest (nthcdr (string-to-number (elmo-filter-value filter) )
2292                            numbers)))
2293         (mapc (lambda (x) (delete x numbers)) rest)
2294         numbers))
2295      ((string= "flag" search-key)
2296       (elmo-imap4-folder-list-flagged
2297        folder (intern (elmo-filter-value filter)) (elmo-filter-type filter)))
2298      ((or (string= "since" search-key)
2299           (string= "before" search-key))
2300       (setq search-key (concat "sent" search-key)
2301             set-list (elmo-imap4-make-number-set-list
2302                       from-msgs
2303                       elmo-imap4-number-set-chop-length)
2304             end nil)
2305       (while (not end)
2306         (setq results
2307               (append
2308                results
2309                (elmo-imap4-response-value
2310                 (elmo-imap4-send-command-wait
2311                  session
2312                  (format
2313                   (if elmo-imap4-use-uid
2314                       "uid search %s%s%s %s"
2315                     "search %s%s%s %s")
2316                   (if from-msgs
2317                       (concat
2318                        (if elmo-imap4-use-uid "uid ")
2319                        (cdr (car set-list))
2320                        " ")
2321                     "")
2322                   (if (eq (elmo-filter-type filter)
2323                           'unmatch)
2324                       "not " "")
2325                   search-key
2326                   (elmo-date-get-description
2327                    (elmo-date-get-datevec
2328                     (elmo-filter-value filter)))))
2329                 'search)))
2330         (setq set-list (cdr set-list)
2331               end (null set-list)))
2332       results)
2333      (t
2334       (setq charset
2335             (if (eq (length (elmo-filter-value filter)) 0)
2336                 (setq charset 'us-ascii)
2337               (elmo-imap4-detect-search-charset
2338                (elmo-filter-value filter)))
2339             set-list (elmo-imap4-make-number-set-list
2340                       from-msgs
2341                       elmo-imap4-number-set-chop-length)
2342             end nil)
2343       (while (not end)
2344         (setq results
2345               (append
2346                results
2347                (elmo-imap4-response-value
2348                 (elmo-imap4-send-command-wait
2349                  session
2350                  (list
2351                   (if elmo-imap4-use-uid "uid ")
2352                   "search "
2353                   "CHARSET "
2354                   (elmo-imap4-astring
2355                    (symbol-name charset))
2356                   " "
2357                   (if from-msgs
2358                       (concat
2359                        (if elmo-imap4-use-uid "uid ")
2360                        (cdr (car set-list))
2361                        " ")
2362                     "")
2363                   (if (eq (elmo-filter-type filter)
2364                           'unmatch)
2365                       "not " "")
2366                   (format "%s%s "
2367                           (if (member
2368                                (elmo-filter-key filter)
2369                                imap-search-keys)
2370                               ""
2371                             "header ")
2372                           (elmo-filter-key filter))
2373                   (elmo-imap4-astring
2374                    (encode-mime-charset-string
2375                     (elmo-filter-value filter) charset))))
2376                 'search)))
2377         (setq set-list (cdr set-list)
2378               end (null set-list)))
2379       results))))
2380
2381 (defun elmo-imap4-search-internal (folder session condition from-msgs)
2382   (let (result)
2383     (cond
2384      ((vectorp condition)
2385       (setq result (elmo-imap4-search-internal-primitive
2386                     folder session condition from-msgs)))
2387      ((eq (car condition) 'and)
2388       (setq result (elmo-imap4-search-internal folder session (nth 1 condition)
2389                                                from-msgs)
2390             result (elmo-list-filter result
2391                                      (elmo-imap4-search-internal
2392                                       folder session (nth 2 condition)
2393                                       from-msgs))))
2394      ((eq (car condition) 'or)
2395       (setq result (elmo-imap4-search-internal
2396                     folder session (nth 1 condition) from-msgs)
2397             result (elmo-uniq-list
2398                     (nconc result
2399                            (elmo-imap4-search-internal
2400                             folder session (nth 2 condition) from-msgs)))
2401             result (sort result '<))))))
2402
2403 (luna-define-method elmo-folder-search :around ((folder elmo-imap4-folder)
2404                                                 condition &optional numbers)
2405   (if (elmo-folder-plugged-p folder)
2406       (save-excursion
2407         (let ((session (elmo-imap4-get-session folder))
2408               ret)
2409           (message "Searching...")
2410           (elmo-imap4-session-select-mailbox
2411            session
2412            (elmo-imap4-folder-mailbox-internal folder))
2413           (setq ret (elmo-imap4-search-internal folder session condition numbers))
2414           (message "Searching...done")
2415           ret))
2416     (luna-call-next-method)))
2417
2418 (luna-define-method elmo-folder-msgdb-create-plugged
2419   ((folder elmo-imap4-folder) numbers flag-table)
2420   (when numbers
2421     (let ((session (elmo-imap4-get-session folder))
2422           (headers
2423            (elmo-uniq-list
2424             (append
2425              '("Subject" "From" "To" "Cc" "Date"
2426                "Message-Id" "References" "In-Reply-To")
2427              (mapcar #'capitalize (elmo-msgdb-extra-fields 'non-virtual)))))
2428           (total 0)
2429           print-length print-depth
2430           rfc2060 set-list)
2431       (setq rfc2060 (elmo-imap4-session-capable-p session 'imap4rev1))
2432       (elmo-with-progress-display (elmo-folder-msgdb-create (length numbers))
2433           "Creating msgdb"
2434         (elmo-imap4-session-select-mailbox
2435          session (elmo-imap4-folder-mailbox-internal folder))
2436         (setq set-list (elmo-imap4-make-number-set-list
2437                         numbers
2438                         elmo-imap4-overview-fetch-chop-length))
2439         ;; Setup callback.
2440         (with-current-buffer (elmo-network-session-buffer session)
2441           (setq elmo-imap4-current-msgdb (elmo-make-msgdb)
2442                 elmo-imap4-seen-messages nil
2443                 elmo-imap4-fetch-callback 'elmo-imap4-fetch-callback-1
2444                 elmo-imap4-fetch-callback-data (cons flag-table folder))
2445           (while set-list
2446             (elmo-imap4-send-command-wait
2447              session
2448              ;; get overview entity from IMAP4
2449              (format "%sfetch %s (%s rfc822.size flags)"
2450                      (if elmo-imap4-use-uid "uid " "")
2451                      (cdr (car set-list))
2452                      (if rfc2060
2453                          (format "body.peek[header.fields %s]" headers)
2454                        (format "%s" headers))))
2455             (setq set-list (cdr set-list)))
2456           (when elmo-imap4-seen-messages
2457             (elmo-imap4-set-flag folder elmo-imap4-seen-messages "\\Seen"))
2458           ;; cannot setup the global flag while retrieval.
2459           (dolist (number (elmo-msgdb-list-messages elmo-imap4-current-msgdb))
2460             (elmo-global-flags-set (elmo-msgdb-flags elmo-imap4-current-msgdb
2461                                                      number)
2462                                    folder number
2463                                    (elmo-message-entity-field
2464                                     (elmo-msgdb-message-entity
2465                                      elmo-imap4-current-msgdb number)
2466                                     'message-id)))
2467           elmo-imap4-current-msgdb)))))
2468
2469 (luna-define-method elmo-folder-set-flag-plugged ((folder elmo-imap4-folder)
2470                                                   numbers flag)
2471   (let ((spec (cdr (assq flag elmo-imap4-flag-specs))))
2472     (elmo-imap4-set-flag folder numbers (or (car spec)
2473                                             (capitalize (symbol-name flag)))
2474                          (nth 1 spec))))
2475
2476 (luna-define-method elmo-folder-unset-flag-plugged ((folder elmo-imap4-folder)
2477                                                     numbers flag)
2478   (let ((spec (cdr (assq flag elmo-imap4-flag-specs))))
2479     (elmo-imap4-set-flag folder numbers (or (car spec)
2480                                             (capitalize (symbol-name flag)))
2481                          (not (nth 1 spec)))))
2482
2483 (luna-define-method elmo-message-use-cache-p ((folder elmo-imap4-folder)
2484                                               number)
2485   elmo-imap4-use-cache)
2486
2487 (luna-define-method elmo-folder-message-appendable-p ((folder elmo-imap4-folder))
2488   (if (elmo-folder-plugged-p folder)
2489       (not (elmo-imap4-session-read-only-internal
2490             (elmo-imap4-get-session folder)))
2491     elmo-enable-disconnected-operation)) ; offline refile.
2492
2493 (luna-define-method elmo-folder-check-plugged ((folder elmo-imap4-folder))
2494   (let ((session (elmo-imap4-get-session folder 'if-exists)))
2495     (when session
2496       (if (string=
2497            (elmo-imap4-session-current-mailbox-internal session)
2498            (elmo-imap4-folder-mailbox-internal folder))
2499           (if elmo-imap4-use-select-to-update-status
2500               (elmo-imap4-session-select-mailbox
2501                session
2502                (elmo-imap4-folder-mailbox-internal folder)
2503                'force)
2504             (elmo-imap4-session-check session))))))
2505
2506 (defsubst elmo-imap4-folder-diff-plugged (folder)
2507   (let ((session (elmo-imap4-get-session folder))
2508         messages new unread response killed uidnext)
2509 ;;;    (elmo-imap4-commit spec)
2510     (with-current-buffer (elmo-network-session-buffer session)
2511       (setq elmo-imap4-status-callback nil)
2512       (setq elmo-imap4-status-callback-data nil))
2513     (if elmo-imap4-use-select-to-update-status
2514         (elmo-imap4-session-select-mailbox
2515          session
2516          (elmo-imap4-folder-mailbox-internal folder)))
2517     (setq response
2518           (elmo-imap4-send-command-wait session
2519                                         (list
2520                                          "status "
2521                                          (elmo-imap4-mailbox
2522                                           (elmo-imap4-folder-mailbox-internal
2523                                            folder))
2524                                          " (recent unseen messages uidnext)")))
2525     (setq response (elmo-imap4-response-value response 'status))
2526     (setq messages (elmo-imap4-response-value response 'messages))
2527     (setq uidnext (elmo-imap4-response-value response 'uidnext))
2528     (setq killed (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder)))
2529     ;;
2530     (when killed
2531       (when (and (consp (car killed))
2532                  (eq (car (car killed)) 1))
2533         (setq messages (- uidnext (cdr (car killed)) 1)))
2534       (setq messages (- messages
2535                         (elmo-msgdb-killed-list-length (cdr killed)))))
2536     (setq new (elmo-imap4-response-value response 'recent)
2537           unread (elmo-imap4-response-value response 'unseen))
2538     (if (< unread new) (setq new unread))
2539     (list new unread messages)))
2540
2541 (luna-define-method elmo-folder-diff-plugged ((folder elmo-imap4-folder))
2542   (elmo-imap4-folder-diff-plugged folder))
2543
2544 (luna-define-method elmo-folder-diff-async ((folder elmo-imap4-folder))
2545   (setq elmo-imap4-server-diff-async-callback
2546         elmo-folder-diff-async-callback)
2547   (setq elmo-imap4-server-diff-async-callback-data
2548         elmo-folder-diff-async-callback-data)
2549   (elmo-imap4-server-diff-async folder))
2550
2551 (luna-define-method elmo-folder-open :around ((folder elmo-imap4-folder)
2552                                               &optional load-msgdb)
2553   (if (elmo-folder-plugged-p folder)
2554       (let (session mailbox msgdb result response tag)
2555         (condition-case err
2556             (progn
2557               (setq session (elmo-imap4-get-session folder)
2558                     mailbox (elmo-imap4-folder-mailbox-internal folder)
2559                     tag (elmo-imap4-send-command session
2560                                                  (list "select "
2561                                                        (elmo-imap4-mailbox
2562                                                         mailbox))))
2563               (message "Selecting %s..."
2564                        (elmo-folder-name-internal folder))
2565               (if load-msgdb
2566                   (setq msgdb (elmo-folder-msgdb-load folder 'silent)))
2567               (elmo-folder-set-killed-list-internal
2568                folder
2569                (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder)))
2570               (if (setq result (elmo-imap4-response-ok-p
2571                                 (setq response
2572                                       (elmo-imap4-read-response session tag))))
2573                   (progn
2574                     (let ((exists (assq 'exists response))) ; update message count,
2575                       (when exists                          ; so merge update can go
2576                         (elmo-folder-set-info-hashtb folder nil (cadr exists))))
2577                     (elmo-imap4-session-set-current-mailbox-internal
2578                      session mailbox)
2579                     (elmo-imap4-session-set-read-only-internal
2580                      session
2581                      (nth 1 (assq 'read-only (assq 'ok response))))
2582                     (elmo-imap4-session-set-flags-internal
2583                      session
2584                      (nth 1 (or (assq 'permanentflags response)
2585                                 (assq 'flags response)))))
2586                 (elmo-imap4-session-set-current-mailbox-internal session nil)
2587                 (if (elmo-imap4-response-bye-p response)
2588                     (elmo-imap4-process-bye session)
2589                   (error "%s"
2590                          (or (elmo-imap4-response-error-text response)
2591                              (format "Select %s failed" mailbox)))))
2592               (message "Selecting %s...done"
2593                        (elmo-folder-name-internal folder))
2594               (elmo-folder-set-msgdb-internal
2595                folder msgdb))
2596           (quit
2597            (if (elmo-imap4-response-ok-p response)
2598                (elmo-imap4-session-set-current-mailbox-internal
2599                 session mailbox)
2600              (and session
2601                   (elmo-imap4-session-set-current-mailbox-internal
2602                    session nil))))
2603           (error
2604            (if (elmo-imap4-response-ok-p response)
2605                (elmo-imap4-session-set-current-mailbox-internal
2606                 session mailbox)
2607              (and session
2608                   (elmo-imap4-session-set-current-mailbox-internal
2609                    session nil))))))
2610     (luna-call-next-method)))
2611
2612 ;; elmo-folder-open-internal: do nothing.
2613
2614 (luna-define-method elmo-find-fetch-strategy ((folder elmo-imap4-folder) number
2615                                               &optional
2616                                               ignore-cache
2617                                               require-entireness)
2618   (let ((entity (elmo-message-entity folder number)))
2619     (if (null entity)
2620         (elmo-make-fetch-strategy 'entire)
2621       (let* ((size (elmo-message-entity-field entity 'size))
2622              (message-id (elmo-message-entity-field entity 'message-id))
2623              (cache-file (elmo-file-cache-get message-id))
2624              (use-cache (and (not ignore-cache)
2625                              (elmo-message-use-cache-p folder number)
2626                              (if require-entireness
2627                                  (eq (elmo-file-cache-status cache-file)
2628                                      'entire)
2629                                (elmo-file-cache-status cache-file)))))
2630         (elmo-make-fetch-strategy
2631          (if use-cache
2632              (elmo-file-cache-status cache-file)
2633            (if (and (not require-entireness)
2634                     elmo-message-fetch-threshold
2635                     (integerp size)
2636                     (>= size elmo-message-fetch-threshold)
2637                     (or (not elmo-message-fetch-confirm)
2638                         (not (prog1
2639                                  (y-or-n-p
2640                                   (format
2641                                    "Fetch entire message at once? (%dbytes)"
2642                                    size))
2643                                (message "")))))
2644                'section
2645              'entire))
2646          use-cache
2647          (elmo-message-use-cache-p folder number)
2648          (elmo-file-cache-path cache-file))))))
2649
2650 (luna-define-method elmo-folder-create-plugged ((folder elmo-imap4-folder))
2651   (elmo-imap4-send-command-wait
2652    (elmo-imap4-get-session folder)
2653    (list "create "
2654          (elmo-imap4-mailbox
2655           (elmo-imap4-folder-mailbox-internal folder)))))
2656
2657 (defun elmo-imap4-flags-to-imap (flags)
2658   "Convert FLAGS to the IMAP flag string."
2659   (let ((imap-flag (if (not (memq 'unread flags)) "\\Seen")))
2660     (dolist (flag flags)
2661       (unless (memq flag '(new read unread cached))
2662         (setq imap-flag
2663               (concat imap-flag
2664                       (if imap-flag " ")
2665                       (or (car (cdr (assq flag elmo-imap4-flag-specs)))
2666                           (capitalize (symbol-name flag)))))))
2667     imap-flag))
2668
2669 (luna-define-method elmo-folder-append-buffer
2670   ((folder elmo-imap4-folder) &optional flags number)
2671   (if (elmo-folder-plugged-p folder)
2672       (let ((session (elmo-imap4-get-session folder))
2673             send-buffer result)
2674         (elmo-imap4-session-select-mailbox session
2675                                            (elmo-imap4-folder-mailbox-internal
2676                                             folder))
2677         (setq send-buffer (elmo-imap4-setup-send-buffer))
2678         (unwind-protect
2679             (setq result
2680                   (elmo-imap4-send-command-wait
2681                    session
2682                    (list
2683                     "append "
2684                     (elmo-imap4-mailbox (elmo-imap4-folder-mailbox-internal
2685                                          folder))
2686                     (if (and flags (elmo-folder-use-flag-p folder))
2687                         (concat " (" (elmo-imap4-flags-to-imap flags) ") ")
2688                       " () ")
2689                     (elmo-imap4-buffer-literal send-buffer))))
2690           (kill-buffer send-buffer))
2691         (when result
2692           (elmo-folder-preserve-flags
2693            folder (elmo-msgdb-get-message-id-from-buffer) flags))
2694         result)
2695     ;; Unplugged
2696     (if elmo-enable-disconnected-operation
2697         (elmo-folder-append-buffer-dop folder flags number)
2698       (error "Unplugged"))))
2699
2700 (eval-when-compile
2701   (defmacro elmo-imap4-identical-system-p (folder1 folder2)
2702     "Return t if FOLDER1 and FOLDER2 are in the same IMAP4 system."
2703     `(and (string= (elmo-net-folder-server-internal ,folder1)
2704                    (elmo-net-folder-server-internal ,folder2))
2705           (eq (elmo-net-folder-port-internal ,folder1)
2706               (elmo-net-folder-port-internal ,folder2))
2707           (string= (elmo-net-folder-user-internal ,folder1)
2708                    (elmo-net-folder-user-internal ,folder2)))))
2709
2710 (luna-define-method elmo-folder-next-message-number-plugged
2711   ((folder elmo-imap4-folder))
2712   (let ((session (elmo-imap4-get-session folder))
2713         messages new unread response killed uidnext)
2714     (with-current-buffer (elmo-network-session-buffer session)
2715       (setq elmo-imap4-status-callback nil)
2716       (setq elmo-imap4-status-callback-data nil))
2717     (if elmo-imap4-use-select-to-update-status
2718         (elmo-imap4-session-select-mailbox
2719          session
2720          (elmo-imap4-folder-mailbox-internal folder)))
2721     (setq response
2722           (elmo-imap4-send-command-wait session
2723                                         (list
2724                                          "status "
2725                                          (elmo-imap4-mailbox
2726                                           (elmo-imap4-folder-mailbox-internal
2727                                            folder))
2728                                          " (uidnext)"))
2729           response (elmo-imap4-response-value response 'status))
2730     (elmo-imap4-response-value response 'uidnext)))
2731
2732 (defun elmo-folder-append-messages-imap4-imap4 (dst-folder
2733                                                 src-folder
2734                                                 numbers
2735                                                 same-number)
2736   (if (and (elmo-imap4-identical-system-p dst-folder src-folder)
2737            (elmo-folder-plugged-p dst-folder))
2738       ;; Plugged
2739       (prog1
2740           (elmo-imap4-copy-messages src-folder dst-folder numbers)
2741         (elmo-progress-notify 'elmo-folder-move-messages (length numbers)))
2742     (elmo-folder-append-messages dst-folder src-folder numbers same-number
2743                                  'elmo-folder-append-messages-imap4-imap4)))
2744
2745 (luna-define-method elmo-message-deletable-p ((folder elmo-imap4-folder)
2746                                               number)
2747   (if (elmo-folder-plugged-p folder)
2748       (not (elmo-imap4-session-read-only-internal
2749             (elmo-imap4-get-session folder)))
2750     elmo-enable-disconnected-operation)) ; offline refile.
2751
2752 ;;;(luna-define-method elmo-message-fetch-unplugged
2753 ;;;  ((folder elmo-imap4-folder)
2754 ;;;   number strategy  &optional section outbuf unseen)
2755 ;;;  (error "%d%s is not cached." number (if section
2756 ;;;                                       (format "(%s)" section)
2757 ;;;                                     "")))
2758
2759 (defsubst elmo-imap4-message-fetch (folder number strategy
2760                                            section outbuf unseen)
2761   (let ((session (elmo-imap4-get-session folder))
2762         response)
2763     (elmo-imap4-session-select-mailbox session
2764                                        (elmo-imap4-folder-mailbox-internal
2765                                         folder))
2766     (with-current-buffer (elmo-network-session-buffer session)
2767       (setq elmo-imap4-fetch-callback nil)
2768       (setq elmo-imap4-fetch-callback-data nil))
2769     (elmo-with-progress-display (elmo-retrieve-message
2770                                  (elmo-message-field folder number :size)
2771                                  elmo-imap4-literal-progress-reporter)
2772         "Retrieving"
2773       (setq response
2774             (elmo-imap4-send-command-wait session
2775                                           (format
2776                                            (if elmo-imap4-use-uid
2777                                                "uid fetch %s body%s[%s]"
2778                                              "fetch %s body%s[%s]")
2779                                            number
2780                                            (if unseen ".peek" "")
2781                                            (or section "")))))
2782     (if (setq response (elmo-imap4-response-bodydetail-text
2783                         (elmo-imap4-response-value-all
2784                          response 'fetch)))
2785         (with-current-buffer outbuf
2786           (erase-buffer)
2787           (insert response)
2788           (elmo-delete-cr-buffer)
2789           t))))
2790
2791 (luna-define-method elmo-message-fetch-plugged ((folder elmo-imap4-folder)
2792                                                 number strategy
2793                                                 &optional section
2794                                                 outbuf unseen)
2795   (when elmo-imap4-set-seen-flag-explicitly
2796     (elmo-imap4-set-flag folder (list number) "\\Seen"))
2797   (elmo-imap4-message-fetch folder number strategy section outbuf unseen))
2798
2799 (luna-define-method elmo-message-fetch-field ((folder elmo-imap4-folder)
2800                                               number field)
2801   (let ((session (elmo-imap4-get-session folder)))
2802     (elmo-imap4-session-select-mailbox session
2803                                        (elmo-imap4-folder-mailbox-internal
2804                                         folder))
2805     (with-current-buffer (elmo-network-session-buffer session)
2806       (setq elmo-imap4-fetch-callback nil)
2807       (setq elmo-imap4-fetch-callback-data nil))
2808     (with-temp-buffer
2809       (insert
2810        (elmo-imap4-response-bodydetail-text
2811         (elmo-imap4-response-value
2812          (elmo-imap4-send-command-wait session
2813                                        (concat
2814                                         (if elmo-imap4-use-uid
2815                                             "uid ")
2816                                         (format
2817                                          "fetch %s (body.peek[header.fields (%s)])"
2818                                          number field)))
2819          'fetch)))
2820       (elmo-delete-cr-buffer)
2821       (goto-char (point-min))
2822       (std11-field-body (symbol-name field)))))
2823
2824 (luna-define-method elmo-folder-search-requires-msgdb-p ((folder
2825                                                           elmo-imap4-folder)
2826                                                          condition)
2827   nil)
2828
2829 (autoload 'elmo-global-flags-set "elmo-flag")
2830 (autoload 'elmo-get-global-flags "elmo-flag")
2831
2832 (require 'product)
2833 (product-provide (provide 'elmo-imap4) (require 'elmo-version))
2834
2835 ;;; elmo-imap4.el ends here