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