nnimap.el 62 KB
Newer Older
1
;;; nnimap.el --- IMAP interface for Gnus
2

3
;; Copyright (C) 2010-2011 Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
4

5 6
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;;         Simon Josefsson <simon@josefsson.org>
Gerd Moellmann's avatar
Gerd Moellmann committed
7 8 9

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Gerd Moellmann's avatar
Gerd Moellmann committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Gerd Moellmann's avatar
Gerd Moellmann committed
14 15 16

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Gerd Moellmann's avatar
Gerd Moellmann committed
18 19 20
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Gerd Moellmann's avatar
Gerd Moellmann committed
22 23 24

;;; Commentary:

25
;; nnimap interfaces Gnus with IMAP servers.
Gerd Moellmann's avatar
Gerd Moellmann committed
26 27 28

;;; Code:

29 30 31 32
;; For Emacs <22.2 and XEmacs.
(eval-and-compile
  (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))

33
(eval-and-compile
34
  (require 'nnheader))
35

36 37
(eval-when-compile
  (require 'cl))
Gerd Moellmann's avatar
Gerd Moellmann committed
38

39 40 41 42
(require 'nnheader)
(require 'gnus-util)
(require 'gnus)
(require 'nnoo)
43
(require 'netrc)
44
(require 'utf7)
45
(require 'tls)
46
(require 'parse-time)
Glenn Morris's avatar
Glenn Morris committed
47
(require 'nnmail)
48
(require 'proto-stream)
Glenn Morris's avatar
Glenn Morris committed
49

50 51
(autoload 'auth-source-forget+ "auth-source")
(autoload 'auth-source-search "auth-source")
52

Gerd Moellmann's avatar
Gerd Moellmann committed
53 54 55
(nnoo-declare nnimap)

(defvoo nnimap-address nil
56
  "The address of the IMAP server.")
Gerd Moellmann's avatar
Gerd Moellmann committed
57 58

(defvoo nnimap-server-port nil
59 60 61 62
  "The IMAP port used.
If nnimap-stream is `ssl', this will default to `imaps'.  If not,
it will default to `imap'.")

63
(defvoo nnimap-stream 'undecided
64
  "How nnimap will talk to the IMAP server.
65 66
Values are `ssl', `network', `starttls' or `shell'.
The default is to try `ssl' first, and then `network'.")
67 68 69 70 71 72 73 74 75 76

(defvoo nnimap-shell-program (if (boundp 'imap-shell-program)
				 (if (listp imap-shell-program)
				     (car imap-shell-program)
				   imap-shell-program)
			       "ssh %s imapd"))

(defvoo nnimap-inbox nil
  "The mail box where incoming mail arrives and should be split out of.")

77 78 79 80
(defvoo nnimap-split-methods nil
  "How mail is split.
Uses the same syntax as nnmail-split-methods")

81 82 83
(defvoo nnimap-split-fancy nil
  "Uses the same syntax as nnmail-split-fancy.")

84 85 86
(defvoo nnimap-unsplittable-articles '(%Deleted %Seen)
  "Articles with the flags in the list will not be considered when splitting.")

87
(make-obsolete-variable 'nnimap-split-rule "see `nnimap-split-methods'"
88
			"Emacs 24.1")
89

90 91 92 93
(defvoo nnimap-authenticator nil
  "How nnimap authenticate itself to the server.
Possible choices are nil (use default methods) or `anonymous'.")

94 95 96 97 98
(defvoo nnimap-expunge t
  "If non-nil, expunge articles after deleting them.
This is always done if the server supports UID EXPUNGE, but it's
not done by default on servers that doesn't support that command.")

99 100 101 102
(defvoo nnimap-streaming t
  "If non-nil, try to use streaming commands with IMAP servers.
Switching this off will make nnimap slower, but it helps with
some servers.")
103

104
(defvoo nnimap-connection-alist nil)
105 106 107

(defvoo nnimap-current-infos nil)

108 109 110 111 112 113 114
(defvoo nnimap-fetch-partial-articles nil
  "If non-nil, Gnus will fetch partial articles.
If t, nnimap will fetch only the first part.  If a string, it
will fetch all parts that have types that match that string.  A
likely value would be \"text/\" to automatically fetch all
textual parts.")

115 116 117
(defvar nnimap-process nil)

(defvar nnimap-status-string "")
118 119 120 121

(defvar nnimap-split-download-body-default nil
  "Internal variable with default value for `nnimap-split-download-body'.")

122 123 124
(defvar nnimap-keepalive-timer nil)
(defvar nnimap-process-buffers nil)

125
(defstruct nnimap
126
  group process commands capabilities select-result newlinep server
127
  last-command-time greeting examined stream-type)
Gerd Moellmann's avatar
Gerd Moellmann committed
128

129 130 131
(defvar nnimap-object nil)

(defvar nnimap-mark-alist
132 133 134
  '((read "\\Seen" %Seen)
    (tick "\\Flagged" %Flagged)
    (reply "\\Answered" %Answered)
135 136 137 138 139 140 141
    (expire "gnus-expire")
    (dormant "gnus-dormant")
    (score "gnus-score")
    (save "gnus-save")
    (download "gnus-download")
    (forward "gnus-forward")))

142 143 144
(defvar nnimap-quirks
  '(("QRESYNC" "Zimbra" "QRESYNC ")))

145 146 147
(defun nnimap-buffer ()
  (nnimap-find-process-buffer nntp-server-buffer))

148 149 150 151 152 153 154 155 156 157
(defun nnimap-header-parameters ()
  (format "(UID RFC822.SIZE BODYSTRUCTURE %s)"
	  (format
	   (if (nnimap-ver4-p)
	       "BODY.PEEK[HEADER.FIELDS %s]"
	     "RFC822.HEADER.LINES %s")
	   (append '(Subject From Date Message-Id
			     References In-Reply-To Xref)
		   nnmail-extra-headers))))

158
(deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
Gerd Moellmann's avatar
Gerd Moellmann committed
159
  (with-current-buffer nntp-server-buffer
160 161 162 163 164 165 166 167
    (erase-buffer)
    (when (nnimap-possibly-change-group group server)
      (with-current-buffer (nnimap-buffer)
	(erase-buffer)
	(nnimap-wait-for-response
	 (nnimap-send-command
	  "UID FETCH %s %s"
	  (nnimap-article-ranges (gnus-compress-sequence articles))
168
	  (nnimap-header-parameters))
169
	 t)
170 171
	(nnimap-transform-headers)
	(nnheader-remove-cr-followed-by-lf))
172 173
      (insert-buffer-substring
       (nnimap-find-process-buffer (current-buffer))))
174
    'headers))
175 176 177

(defun nnimap-transform-headers ()
  (goto-char (point-min))
178
  (let (article bytes lines size string)
179 180 181 182 183 184
    (block nil
      (while (not (eobp))
	(while (not (looking-at "^\\* [0-9]+ FETCH.*UID \\([0-9]+\\)"))
	  (delete-region (point) (progn (forward-line 1) (point)))
	  (when (eobp)
	    (return)))
185
	(setq article (match-string 1))
186 187 188 189 190 191 192 193
	;; Unfold quoted {number} strings.
	(while (re-search-forward "[^]][ (]{\\([0-9]+\\)}\r?\n"
				  (1+ (line-end-position)) t)
	  (setq size (string-to-number (match-string 1)))
	  (delete-region (+ (match-beginning 0) 2) (point))
	  (setq string (buffer-substring (point) (+ (point) size)))
	  (delete-region (point) (+ (point) size))
	  (insert (format "%S" string)))
194
	(setq bytes (nnimap-get-length)
195 196
	      lines nil)
	(beginning-of-line)
197 198 199 200 201 202
	(setq size
	      (and (re-search-forward "RFC822.SIZE \\([0-9]+\\)"
				      (line-end-position)
				      t)
		   (match-string 1)))
	(beginning-of-line)
203
	(when (search-forward "BODYSTRUCTURE" (line-end-position) t)
204 205
	  (let ((structure (ignore-errors
			     (read (current-buffer)))))
206 207 208 209 210 211 212
	    (while (and (consp structure)
			(not (stringp (car structure))))
	      (setq structure (car structure)))
	    (setq lines (nth 7 structure))))
	(delete-region (line-beginning-position) (line-end-position))
	(insert (format "211 %s Article retrieved." article))
	(forward-line 1)
213 214
	(when size
	  (insert (format "Chars: %s\n" size)))
215 216
	(when lines
	  (insert (format "Lines: %s\n" lines)))
217 218
	(unless (re-search-forward "^\r$" nil t)
	  (goto-char (point-max)))
219 220 221 222
	(delete-region (line-beginning-position) (line-end-position))
	(insert ".")
	(forward-line 1)))))

223 224
(defun nnimap-unfold-quoted-lines ()
  ;; Unfold quoted {number} strings.
225 226 227 228 229 230 231
  (let (size string)
    (while (re-search-forward " {\\([0-9]+\\)}\r?\n" nil t)
      (setq size (string-to-number (match-string 1)))
      (delete-region (1+ (match-beginning 0)) (point))
      (setq string (buffer-substring (point) (+ (point) size)))
      (delete-region (point) (+ (point) size))
      (insert (format "%S" string)))))
232

233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
(defun nnimap-get-length ()
  (and (re-search-forward "{\\([0-9]+\\)}" (line-end-position) t)
       (string-to-number (match-string 1))))

(defun nnimap-article-ranges (ranges)
  (let (result)
    (cond
     ((numberp ranges)
      (number-to-string ranges))
     ((numberp (cdr ranges))
      (format "%d:%d" (car ranges) (cdr ranges)))
     (t
      (dolist (elem ranges)
	(push
	 (if (consp elem)
	     (format "%d:%d" (car elem) (cdr elem))
	   (number-to-string elem))
	 result))
      (mapconcat #'identity (nreverse result) ",")))))

253
(deffoo nnimap-open-server (server &optional defs)
Gerd Moellmann's avatar
Gerd Moellmann committed
254 255 256
  (if (nnimap-server-opened server)
      t
    (unless (assq 'nnimap-address defs)
257
      (setq defs (append defs (list (list 'nnimap-address server)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
258
    (nnoo-change-server 'nnimap server defs)
259 260 261 262 263 264 265 266 267 268 269 270
    (or (nnimap-find-connection nntp-server-buffer)
	(nnimap-open-connection nntp-server-buffer))))

(defun nnimap-make-process-buffer (buffer)
  (with-current-buffer
      (generate-new-buffer (format "*nnimap %s %s %s*"
				   nnimap-address nnimap-server-port
				   (gnus-buffer-exists-p buffer)))
    (mm-disable-multibyte)
    (buffer-disable-undo)
    (gnus-add-buffer)
    (set (make-local-variable 'after-change-functions) nil)
271 272
    (set (make-local-variable 'nnimap-object)
	 (make-nnimap :server (nnoo-current-server 'nnimap)))
273
    (push (list buffer (current-buffer)) nnimap-connection-alist)
274
    (push (current-buffer) nnimap-process-buffers)
275 276
    (current-buffer)))

277
(defun nnimap-credentials (address ports &optional inhibit-create)
278 279 280 281 282 283 284 285 286 287 288 289
  (let* ((found (nth 0 (auth-source-search :max 1
                                           :host address
                                           :port ports
                                           :create (if inhibit-create
                                                       nil
                                                     (null ports)))))
         (user (plist-get found :user))
         (secret (plist-get found :secret))
         (secret (if (functionp secret) (funcall secret) secret)))
    (if found
        (list user secret)
      nil)))
290

291 292 293 294 295 296 297
(defun nnimap-keepalive ()
  (let ((now (current-time)))
    (dolist (buffer nnimap-process-buffers)
      (when (buffer-name buffer)
	(with-current-buffer buffer
	  (when (and nnimap-object
		     (nnimap-last-command-time nnimap-object)
Glenn Morris's avatar
Glenn Morris committed
298
		     (> (gnus-float-time
299 300 301 302 303 304 305
			 (time-subtract
			  now
			  (nnimap-last-command-time nnimap-object)))
			;; More than five minutes since the last command.
			(* 5 60)))
	    (nnimap-send-command "NOOP")))))))

306
(defun nnimap-open-connection (buffer)
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
  ;; Be backwards-compatible -- the earlier value of nnimap-stream was
  ;; `ssl' when nnimap-server-port was nil.  Sort of.
  (when (and nnimap-server-port
	     (eq nnimap-stream 'undecided))
    (setq nnimap-stream 'ssl))
  (let ((stream
	 (if (eq nnimap-stream 'undecided)
	     (loop for type in '(ssl network)
		   for stream = (let ((nnimap-stream type))
				  (nnimap-open-connection-1 buffer))
		   while (eq stream 'no-connect)
		   finally (return stream))
	   (nnimap-open-connection-1 buffer))))
    (if (eq stream 'no-connect)
	nil
      stream)))

(defun nnimap-open-connection-1 (buffer)
325 326 327
  (unless nnimap-keepalive-timer
    (setq nnimap-keepalive-timer (run-at-time (* 60 15) (* 60 15)
					      'nnimap-keepalive)))
328 329 330 331 332
  (with-current-buffer (nnimap-make-process-buffer buffer)
    (let* ((coding-system-for-read 'binary)
	   (coding-system-for-write 'binary)
	   (port nil)
	   (ports
333
	    (cond
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
	     ((or (eq nnimap-stream 'network)
		  (eq nnimap-stream 'starttls))
	      (nnheader-message 7 "Opening connection to %s..."
				nnimap-address)
	      '("143" "imap"))
	     ((eq nnimap-stream 'shell)
	      (nnheader-message 7 "Opening connection to %s via shell..."
				nnimap-address)
	      '("imap"))
	     ((memq nnimap-stream '(ssl tls))
	      (nnheader-message 7 "Opening connection to %s via tls..."
				nnimap-address)
	      '("143" "993" "imap" "imaps"))
	     (t
	      (error "Unknown stream type: %s" nnimap-stream))))
	   (proto-stream-always-use-starttls t)
           login-result credentials)
      (when nnimap-server-port
	(setq ports (append ports (list nnimap-server-port))))
353
      (destructuring-bind (stream greeting capabilities stream-type)
354 355 356 357 358 359 360 361 362 363 364
	  (open-protocol-stream
	   "*nnimap*" (current-buffer) nnimap-address (car (last ports))
	   :type nnimap-stream
	   :shell-command nnimap-shell-program
	   :capability-command "1 CAPABILITY\r\n"
	   :success " OK "
	   :starttls-function
	   (lambda (capabilities)
	     (when (gnus-string-match-p "STARTTLS" capabilities)
	       "1 STARTTLS\r\n")))
	(setf (nnimap-process nnimap-object) stream)
365
	(setf (nnimap-stream-type nnimap-object) stream-type)
366 367 368 369 370 371 372 373 374 375 376 377 378 379
	(if (not stream)
	    (progn
	      (nnheader-report 'nnimap "Unable to contact %s:%s via %s"
			       nnimap-address port nnimap-stream)
	      'no-connect)
	  (gnus-set-process-query-on-exit-flag stream nil)
	  (if (not (gnus-string-match-p "[*.] \\(OK\\|PREAUTH\\)" greeting))
	      (nnheader-report 'nnimap "%s" greeting)
	    ;; Store the greeting (for debugging purposes).
	    (setf (nnimap-greeting nnimap-object) greeting)
	    (setf (nnimap-capabilities nnimap-object)
		  (mapcar #'upcase
			  (split-string capabilities)))
	    (unless (gnus-string-match-p "[*.] PREAUTH" greeting)
380 381 382 383
	      (if (not (setq credentials
			     (if (eq nnimap-authenticator 'anonymous)
				 (list "anonymous"
				       (message-make-address))
384 385 386 387 388 389 390
                               ;; Look for the credentials based on
                               ;; the virtual server name and the address
                               (nnimap-credentials
                                (list
                                 (nnoo-current-server 'nnimap)
                                 nnimap-address)
                                ports t))))
391
		  (setq nnimap-object nil)
392
		(setq login-result
393
		      (nnimap-login (car credentials) (cadr credentials)))
394 395 396 397 398 399
		(unless (car login-result)
		  ;; If the login failed, then forget the credentials
		  ;; that are now possibly cached.
		  (dolist (host (list (nnoo-current-server 'nnimap)
				      nnimap-address))
		    (dolist (port ports)
400
                      (auth-source-forget+ :host host :protocol port)))
401 402 403
		  (delete-process (nnimap-process nnimap-object))
		  (setq nnimap-object nil))))
	    (when nnimap-object
404
	      (when (nnimap-capability "QRESYNC")
405
		(nnimap-command "ENABLE QRESYNC"))
406 407
	      (nnimap-process nnimap-object))))))))

408 409 410 411
(autoload 'rfc2104-hash "rfc2104")

(defun nnimap-login (user password)
  (cond
412 413 414 415 416 417
   ;; Prefer plain LOGIN if it's enabled (since it requires fewer
   ;; round trips than CRAM-MD5, and it's less likely to be buggy),
   ;; and we're using an encrypted connection.
   ((and (not (nnimap-capability "LOGINDISABLED"))
	 (eq (nnimap-stream-type nnimap-object) 'tls))
    (nnimap-command "LOGIN %S %S" user password))
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
   ((nnimap-capability "AUTH=CRAM-MD5")
    (erase-buffer)
    (let ((sequence (nnimap-send-command "AUTHENTICATE CRAM-MD5"))
	  (challenge (nnimap-wait-for-line "^\\+\\(.*\\)\n")))
      (process-send-string
       (get-buffer-process (current-buffer))
       (concat
	(base64-encode-string
	 (concat user " "
		 (rfc2104-hash 'md5 64 16 password
			       (base64-decode-string challenge))))
	"\r\n"))
      (nnimap-wait-for-response sequence)))
   ((not (nnimap-capability "LOGINDISABLED"))
    (nnimap-command "LOGIN %S %S" user password))
   ((nnimap-capability "AUTH=PLAIN")
    (nnimap-command
     "AUTHENTICATE PLAIN %s"
     (base64-encode-string
      (format "\000%s\000%s"
	      (nnimap-quote-specials user)
	      (nnimap-quote-specials password)))))))

441 442 443 444 445 446 447 448 449 450
(defun nnimap-quote-specials (string)
  (with-temp-buffer
    (insert string)
    (goto-char (point-min))
    (while (re-search-forward "[\\\"]" nil t)
      (forward-char -1)
      (insert "\\")
      (forward-char 1))
    (buffer-string)))

451 452 453 454 455 456 457 458 459 460 461 462
(defun nnimap-find-parameter (parameter elems)
  (let (result)
    (dolist (elem elems)
      (cond
       ((equal (car elem) parameter)
	(setq result (cdr elem)))
       ((and (equal (car elem) "OK")
	     (consp (cadr elem))
	     (equal (caadr elem) parameter))
	(setq result (cdr (cadr elem))))))
    result))

463
(deffoo nnimap-close-server (&optional server)
464 465 466
  (when (nnoo-change-server 'nnimap server nil)
    (ignore-errors
      (delete-process (get-buffer-process (nnimap-buffer))))
467
    (nnoo-close-server 'nnimap server)
468
    t))
Gerd Moellmann's avatar
Gerd Moellmann committed
469

470
(deffoo nnimap-request-close ()
471
  t)
472

473
(deffoo nnimap-server-opened (&optional server)
474 475 476 477
  (and (nnoo-current-server-p 'nnimap server)
       nntp-server-buffer
       (gnus-buffer-live-p nntp-server-buffer)
       (nnimap-find-connection nntp-server-buffer)))
Gerd Moellmann's avatar
Gerd Moellmann committed
478

479
(deffoo nnimap-status-message (&optional server)
480
  nnimap-status-string)
Gerd Moellmann's avatar
Gerd Moellmann committed
481

482
(deffoo nnimap-request-article (article &optional group server to-buffer)
Gerd Moellmann's avatar
Gerd Moellmann committed
483
  (with-current-buffer nntp-server-buffer
484
    (let ((result (nnimap-possibly-change-group group server))
485
	  parts structure)
486 487 488 489 490 491 492
      (when (stringp article)
	(setq article (nnimap-find-article-by-message-id group article)))
      (when (and result
		 article)
	(erase-buffer)
	(with-current-buffer (nnimap-buffer)
	  (erase-buffer)
493 494 495 496
	  (when nnimap-fetch-partial-articles
	    (nnimap-command "UID FETCH %d (BODYSTRUCTURE)" article)
	    (goto-char (point-min))
	    (when (re-search-forward "FETCH.*BODYSTRUCTURE" nil t)
497 498 499 500
	      (setq structure (ignore-errors
				(let ((start (point)))
				  (forward-sexp 1)
				  (downcase-region start (point))
501
				  (goto-char start)
502
				  (read (current-buffer))))
503
		    parts (nnimap-find-wanted-parts structure))))
504 505 506 507 508 509 510 511 512 513
	  (when (if parts
		    (nnimap-get-partial-article article parts structure)
		  (nnimap-get-whole-article article))
	    (let ((buffer (current-buffer)))
	      (with-current-buffer (or to-buffer nntp-server-buffer)
		(erase-buffer)
		(insert-buffer-substring buffer)
		(nnheader-ms-strip-cr)
		(cons group article)))))))))

514 515 516 517 518
(deffoo nnimap-request-head (article &optional group server to-buffer)
  (when (nnimap-possibly-change-group group server)
    (with-current-buffer (nnimap-buffer)
      (when (stringp article)
	(setq article (nnimap-find-article-by-message-id group article)))
519 520 521 522 523 524 525 526 527 528 529
      (if (null article)
	  nil
	(nnimap-get-whole-article
	 article (format "UID FETCH %%d %s"
			 (nnimap-header-parameters)))
	(let ((buffer (current-buffer)))
	  (with-current-buffer (or to-buffer nntp-server-buffer)
	    (erase-buffer)
	    (insert-buffer-substring buffer)
	    (nnheader-ms-strip-cr)
	    (cons group article)))))))
530 531

(defun nnimap-get-whole-article (article &optional command)
532 533
  (let ((result
	 (nnimap-command
534 535 536 537
	  (or command
	      (if (nnimap-ver4-p)
		  "UID FETCH %d BODY.PEEK[]"
		"UID FETCH %d RFC822.PEEK"))
538 539 540
	  article)))
    ;; Check that we really got an article.
    (goto-char (point-min))
541
    (unless (re-search-forward "\\* [0-9]+ FETCH" nil t)
542 543
      (setq result nil))
    (when result
544 545 546 547
      ;; Remove any data that may have arrived before the FETCH data.
      (beginning-of-line)
      (unless (bobp)
	(delete-region (point-min) (point)))
548 549 550 551 552 553 554
      (let ((bytes (nnimap-get-length)))
	(delete-region (line-beginning-position)
		       (progn (forward-line 1) (point)))
	(goto-char (+ (point) bytes))
	(delete-region (point) (point-max)))
      t)))

555 556 557
(defun nnimap-capability (capability)
  (member capability (nnimap-capabilities nnimap-object)))

558
(defun nnimap-ver4-p ()
559
  (nnimap-capability "IMAP4REV1"))
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590

(defun nnimap-get-partial-article (article parts structure)
  (let ((result
	 (nnimap-command
	  "UID FETCH %d (%s %s)"
	  article
	  (if (nnimap-ver4-p)
	      "BODY.PEEK[HEADER]"
	    "RFC822.HEADER")
	  (if (nnimap-ver4-p)
	      (mapconcat (lambda (part)
			   (format "BODY.PEEK[%s]" part))
			 parts " ")
	    (mapconcat (lambda (part)
			 (format "RFC822.PEEK[%s]" part))
		       parts " ")))))
    (when result
      (nnimap-convert-partial-article structure))))

(defun nnimap-convert-partial-article (structure)
  ;; First just skip past the headers.
  (goto-char (point-min))
  (let ((bytes (nnimap-get-length))
	id parts)
    ;; Delete "FETCH" line.
    (delete-region (line-beginning-position)
		   (progn (forward-line 1) (point)))
    (goto-char (+ (point) bytes))
    ;; Collect all the body parts.
    (while (looking-at ".*BODY\\[\\([.0-9]+\\)\\]")
      (setq id (match-string 1)
591
	    bytes (or (nnimap-get-length) 0))
592 593 594 595 596 597 598 599 600 601 602 603
      (beginning-of-line)
      (delete-region (point) (progn (forward-line 1) (point)))
      (push (list id (buffer-substring (point) (+ (point) bytes)))
	    parts)
      (delete-region (point) (+ (point) bytes)))
    ;; Delete trailing junk.
    (delete-region (point) (point-max))
    ;; Now insert all the parts again where they fit in the structure.
    (nnimap-insert-partial-structure structure parts)
    t))

(defun nnimap-insert-partial-structure (structure parts &optional subp)
604 605 606 607 608 609
  (let (type boundary)
    (let ((bstruc structure))
      (while (consp (car bstruc))
	(pop bstruc))
      (setq type (car bstruc))
      (setq bstruc (car (cdr bstruc)))
610 611 612
      (let ((has-boundary (member "boundary" bstruc)))
        (when has-boundary
          (setq boundary (cadr has-boundary)))))
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
    (when subp
      (insert (format "Content-type: multipart/%s; boundary=%S\n\n"
		      (downcase type) boundary)))
    (while (not (stringp (car structure)))
      (insert "\n--" boundary "\n")
      (if (consp (caar structure))
	  (nnimap-insert-partial-structure (pop structure) parts t)
	(let ((bit (pop structure)))
	  (insert (format  "Content-type: %s/%s"
			   (downcase (nth 0 bit))
			   (downcase (nth 1 bit))))
	  (if (member "CHARSET" (nth 2 bit))
	      (insert (format
		       "; charset=%S\n" (cadr (member "CHARSET" (nth 2 bit)))))
	    (insert "\n"))
	  (insert (format "Content-transfer-encoding: %s\n"
			  (nth 5 bit)))
	  (insert "\n")
	  (when (assoc (nth 9 bit) parts)
	    (insert (cadr (assoc (nth 9 bit) parts)))))))
    (insert "\n--" boundary "--\n")))
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648

(defun nnimap-find-wanted-parts (structure)
  (message-flatten-list (nnimap-find-wanted-parts-1 structure "")))

(defun nnimap-find-wanted-parts-1 (structure prefix)
  (let ((num 1)
	parts)
    (while (consp (car structure))
      (let ((sub (pop structure)))
	(if (consp (car sub))
	    (push (nnimap-find-wanted-parts-1
		   sub (if (string= prefix "")
			   (number-to-string num)
			 (format "%s.%s" prefix num)))
		  parts)
649 650
	  (let ((type (format "%s/%s" (nth 0 sub) (nth 1 sub)))
		(id (if (string= prefix "")
651
			(number-to-string num)
652 653
		      (format "%s.%s" prefix num))))
	    (setcar (nthcdr 9 sub) id)
654 655 656
	    (when (if (eq nnimap-fetch-partial-articles t)
		      (equal id "1")
		    (string-match nnimap-fetch-partial-articles type))
657 658
	      (push id parts))))
	(incf num)))
659
    (nreverse parts)))
660

661
(deffoo nnimap-request-group (group &optional server dont-check info)
662 663 664
  (let ((result (nnimap-possibly-change-group
		 ;; Don't SELECT the group if we're going to select it
		 ;; later, anyway.
665
		 (if (and (not dont-check)
666
			  (assoc group nnimap-current-infos))
667 668 669
		     nil
		   group)
		 server))
670 671
	articles active marks high low)
    (with-current-buffer nntp-server-buffer
672
      (when result
673 674 675 676 677 678 679 680 681 682
	(if (and dont-check
		 (setq active (nth 2 (assoc group nnimap-current-infos))))
	    (insert (format "211 %d %d %d %S\n"
			    (- (cdr active) (car active))
			    (car active)
			    (cdr active)
			    group))
	  (with-current-buffer (nnimap-buffer)
	    (erase-buffer)
	    (let ((group-sequence
683
		   (nnimap-send-command "SELECT %S" (utf7-encode group t)))
684 685
		  (flag-sequence
		   (nnimap-send-command "UID FETCH 1:* FLAGS")))
686
	      (setf (nnimap-group nnimap-object) group)
687 688 689 690
	      (nnimap-wait-for-response flag-sequence)
	      (setq marks
		    (nnimap-flags-to-marks
		     (nnimap-parse-flags
691 692 693 694
		      (list (list group-sequence flag-sequence
				  1 group "SELECT")))))
	      (when (and info
			 marks)
695 696
		(nnimap-update-infos marks (list info))
		(nnimap-store-info info (gnus-active (gnus-info-group info))))
697
	      (goto-char (point-max))
698
	      (let ((uidnext (nth 5 (car marks))))
699 700 701 702 703
		(setq high (or (if uidnext
                                   (1- uidnext)
                                 (nth 3 (car marks)))
                               0)
		      low (or (nth 4 (car marks)) uidnext 1)))))
704 705 706
	  (erase-buffer)
	  (insert
	   (format
707 708 709 710 711 712 713
	    "211 %d %d %d %S\n" (1+ (- high low)) low high group)))
	t))))

(deffoo nnimap-request-create-group (group &optional server args)
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
      (car (nnimap-command "CREATE %S" (utf7-encode group t))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
714

715 716 717
(deffoo nnimap-request-delete-group (group &optional force server)
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
718 719
      (car (nnimap-command "DELETE %S" (utf7-encode group t))))))

720 721 722
(deffoo nnimap-request-rename-group (group new-name &optional server)
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
723
      (nnimap-unselect-group)
724 725
      (car (nnimap-command "RENAME %S %S"
			   (utf7-encode group t) (utf7-encode new-name t))))))
726

727 728 729 730 731 732 733
(defun nnimap-unselect-group ()
  ;; Make sure we don't have this group open read/write by asking
  ;; to examine a mailbox that doesn't exist.  This seems to be
  ;; the only way that allows us to reliably go back to unselected
  ;; state on Courier.
  (nnimap-command "EXAMINE DOES.NOT.EXIST"))

734 735 736 737
(deffoo nnimap-request-expunge-group (group &optional server)
  (when (nnimap-possibly-change-group group server)
    (with-current-buffer (nnimap-buffer)
      (car (nnimap-command "EXPUNGE")))))
738

739 740
(defun nnimap-get-flags (spec)
  (let ((articles nil)
741
	elems end)
742
    (with-current-buffer (nnimap-buffer)
Gerd Moellmann's avatar
Gerd Moellmann committed
743
      (erase-buffer)
744 745
      (nnimap-wait-for-response (nnimap-send-command
				 "UID FETCH %s FLAGS" spec))
746 747 748
      (setq end (point))
      (subst-char-in-region (point-min) (point-max)
			    ?\\ ?% t)
749
      (goto-char (point-min))
750 751 752 753
      (while (search-forward " FETCH " end t)
	(setq elems (read (current-buffer)))
	(push (cons (cadr (memq 'UID elems))
		    (cadr (memq 'FLAGS elems)))
754 755
	      articles)))
    (nreverse articles)))
756

757
(deffoo nnimap-close-group (group &optional server)
758
  t)
Gerd Moellmann's avatar
Gerd Moellmann committed
759

760
(deffoo nnimap-request-move-article (article group server accept-form
761
					     &optional last internal-move-group)
762
  (with-temp-buffer
763
    (mm-disable-multibyte)
764 765 766 767
    (when (funcall (if internal-move-group
		       'nnimap-request-head
		     'nnimap-request-article)
		   article group server (current-buffer))
768 769 770 771 772 773 774 775 776 777
      ;; If the move is internal (on the same server), just do it the easy
      ;; way.
      (let ((message-id (message-field-value "message-id")))
	(if internal-move-group
	    (let ((result
		   (with-current-buffer (nnimap-buffer)
		     (nnimap-command "UID COPY %d %S"
				     article
				     (utf7-encode internal-move-group t)))))
	      (when (car result)
778
		(nnimap-delete-article article)
779
		(cons internal-move-group
780 781 782
		      (or (nnimap-find-uid-response "COPYUID" (cadr result))
			  (nnimap-find-article-by-message-id
			   internal-move-group message-id)))))
783 784 785 786 787
	  ;; Move the article to a different method.
	  (let ((result (eval accept-form)))
	    (when result
	      (nnimap-delete-article article)
	      result)))))))
788 789 790

(deffoo nnimap-request-expire-articles (articles group &optional server force)
  (cond
791 792
   ((null articles)
    nil)
793 794
   ((not (nnimap-possibly-change-group group server))
    articles)
795 796
   ((and force
	 (eq nnmail-expiry-target 'delete))
797
    (unless (nnimap-delete-article (gnus-compress-sequence articles))
798
      (nnheader-message 7 "Article marked for deletion, but not expunged."))
799 800
    nil)
   (t
801
    (let ((deletable-articles
802 803
	   (if (or force
		   (eq nnmail-expiry-wait 'immediate))
804 805 806 807 808 809 810
	       articles
	     (gnus-sorted-intersection
	      articles
	      (nnimap-find-expired-articles group)))))
      (if (null deletable-articles)
	  articles
	(if (eq nnmail-expiry-target 'delete)
811
	    (nnimap-delete-article (gnus-compress-sequence deletable-articles))
812 813 814 815 816 817 818 819
	  (setq deletable-articles
		(nnimap-process-expiry-targets
		 deletable-articles group server)))
	;; Return the articles we didn't delete.
	(gnus-sorted-complement articles deletable-articles))))))

(defun nnimap-process-expiry-targets (articles group server)
  (let ((deleted-articles nil))
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
    (cond
     ;; shortcut further processing if we're going to delete the articles
     ((eq nnmail-expiry-target 'delete)
      (setq deleted-articles articles)
      t)
     ;; or just move them to another folder on the same IMAP server
     ((and (not (functionp nnmail-expiry-target))
	   (gnus-server-equal (gnus-group-method nnmail-expiry-target)
			      (gnus-server-to-method
			       (format "nnimap:%s" server))))
      (and (nnimap-possibly-change-group group server)
	   (with-current-buffer (nnimap-buffer)
	     (nnheader-message 7 "Expiring articles from %s: %s" group articles)
	     (nnimap-command
	      "UID COPY %s %S"
	      (nnimap-article-ranges (gnus-compress-sequence articles))
	      (utf7-encode (gnus-group-real-name nnmail-expiry-target) t))
	     (setq deleted-articles articles)))
      t)
     (t
      (dolist (article articles)
	(let ((target nnmail-expiry-target))
	  (with-temp-buffer
	    (mm-disable-multibyte)
	    (when (nnimap-request-article article group server (current-buffer))
	      (nnheader-message 7 "Expiring article %s:%d" group article)
	      (when (functionp target)
		(setq target (funcall target group)))
	      (when (and target
			 (not (eq target 'delete)))
		(if (or (gnus-request-group target t)
			(gnus-request-create-group target))
		    (nnmail-expiry-target-group target group)
		  (setq target nil)))
	      (when target
		(push article deleted-articles))))))))
856 857 858
    ;; Change back to the current group again.
    (nnimap-possibly-change-group group server)
    (setq deleted-articles (nreverse deleted-articles))
859
    (nnimap-delete-article (gnus-compress-sequence deleted-articles))
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
    deleted-articles))

(defun nnimap-find-expired-articles (group)
  (let ((cutoff (nnmail-expired-article-p group nil nil)))
    (with-current-buffer (nnimap-buffer)
      (let ((result
	     (nnimap-command
	      "UID SEARCH SENTBEFORE %s"
	      (format-time-string
	       (format "%%d-%s-%%Y"
		       (upcase
			(car (rassoc (nth 4 (decode-time cutoff))
				     parse-time-months))))
	       cutoff))))
	(and (car result)
	     (delete 0 (mapcar #'string-to-number
			       (cdr (assoc "SEARCH" (cdr result))))))))))

878 879

(defun nnimap-find-article-by-message-id (group message-id)
880 881
  (with-current-buffer (nnimap-buffer)
    (erase-buffer)
882 883
    (unless (equal group (nnimap-group nnimap-object))
      (setf (nnimap-group nnimap-object) nil)
884
      (setf (nnimap-examined nnimap-object) group)
885
      (nnimap-send-command "EXAMINE %S" (utf7-encode group t)))
886 887 888 889 890 891 892 893 894 895
    (let ((sequence
	   (nnimap-send-command "UID SEARCH HEADER Message-Id %S" message-id))
	  article result)
      (setq result (nnimap-wait-for-response sequence))
      (when (and result
		 (car (setq result (nnimap-parse-response))))
	;; Select the last instance of the message in the group.
	(and (setq article
		   (car (last (assoc "SEARCH" (cdr result)))))
	     (string-to-number article))))))
896 897 898 899 900

(defun nnimap-delete-article (articles)
  (with-current-buffer (nnimap-buffer)
    (nnimap-command "UID STORE %s +FLAGS.SILENT (\\Deleted)"
		    (nnimap-article-ranges articles))
901
    (cond
902
     ((nnimap-capability "UIDPLUS")
903 904 905 906 907
      (nnimap-command "UID EXPUNGE %s"
		      (nnimap-article-ranges articles))
      t)
     (nnimap-expunge
      (nnimap-command "EXPUNGE")
908 909 910 911
      t)
     (t (gnus-message 7 (concat "nnimap: nnimap-expunge is not set and the "
                                "server doesn't support UIDPLUS, so we won't "
                                "delete this article now"))))))
912 913 914 915 916

(deffoo nnimap-request-scan (&optional group server)
  (when (and (nnimap-possibly-change-group nil server)
	     nnimap-inbox
	     nnimap-split-methods)
917
    (nnheader-message 7 "nnimap %s splitting mail..." server)
918 919 920 921 922 923 924 925 926
    (nnimap-split-incoming-mail)))

(defun nnimap-marks-to-flags (marks)
  (let (flags flag)
    (dolist (mark marks)
      (when (setq flag (cadr (assq mark nnimap-mark-alist)))
	(push flag flags)))
    flags))

927 928 929 930 931 932 933 934 935 936
(deffoo nnimap-request-update-group-status (group status &optional server)
  (when (nnimap-possibly-change-group nil server)
    (let ((command (assoc
		    status
		    '((subscribe "SUBSCRIBE")
		      (unsubscribe "UNSUBSCRIBE")))))
      (when command
	(with-current-buffer (nnimap-buffer)
	  (nnimap-command "%s %S" (cadr command) (utf7-encode group t)))))))

937
(deffoo nnimap-request-set-mark (group actions &optional server)
938 939 940
  (when (nnimap-possibly-change-group group server)
    (let (sequence)
      (with-current-buffer (nnimap-buffer)
941
	(erase-buffer)
942 943 944 945 946 947 948 949 950
	;; Just send all the STORE commands without waiting for
	;; response.  If they're successful, they're successful.
	(dolist (action actions)
	  (destructuring-bind (range action marks) action
	    (let ((flags (nnimap-marks-to-flags marks)))
	      (when flags
		(setq sequence (nnimap-send-command
				"UID STORE %s %sFLAGS.SILENT (%s)"
				(nnimap-article-ranges range)
951 952
				(cond
				 ((eq action 'del) "-")
953
				 ((eq action 'add) "+")
954
				 ((eq action 'set) ""))
955 956 957
				(mapconcat #'identity flags " ")))))))
	;; Wait for the last command to complete to avoid later
	;; syncronisation problems with the stream.
958 959
	(when sequence
	  (nnimap-wait-for-response sequence))))))
960

Gerd Moellmann's avatar
Gerd Moellmann committed
961
(deffoo nnimap-request-accept-article (group &optional server last)
962 963
  (when (nnimap-possibly-change-group nil server)
    (nnmail-check-syntax)
964 965 966
    (let ((message-id (message-field-value "message-id"))
	  sequence message)
      (nnimap-add-cr)
967
      (setq message (buffer-substring-no-properties (point-min) (point-max)))
968
      (with-current-buffer (nnimap-buffer)
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
	(when (setq message (nnimap-process-quirk "OK Gimap " 'append message))
	  ;; If we have this group open read-only, then unselect it
	  ;; before appending to it.
	  (when (equal (nnimap-examined nnimap-object) group)
	    (nnimap-unselect-group))
	  (erase-buffer)
	  (setq sequence (nnimap-send-command
			  "APPEND %S {%d}" (utf7-encode group t)
			  (length message)))
	  (unless nnimap-streaming
	    (nnimap-wait-for-connection "^[+]"))
	  (process-send-string (get-buffer-process (current-buffer)) message)
	  (process-send-string (get-buffer-process (current-buffer))
			       (if (nnimap-newlinep nnimap-object)
				   "\n"
				 "\r\n"))
	  (let ((result (nnimap-get-response sequence)))
	    (if (not (nnimap-ok-p result))
		(progn
		  (nnheader-report 'nnimap "%s" result)
		  nil)
	      (cons group
		    (or (nnimap-find-uid-response "APPENDUID" (car result))
			(nnimap-find-article-by-message-id
			 group message-id))))))))))

(defun nnimap-process-quirk (greeting-match type data)
  (when (and (nnimap-greeting nnimap-object)
	     (string-match "OK Gimap " (nnimap-greeting nnimap-object))
	     (eq type 'append)
	     (string-match "\000" data))
    (let ((choice (gnus-multiple-choice
		   "Message contains NUL characters.  Delete, continue, abort? "
		   '((?d "Delete NUL characters")
		     (?c "Try to APPEND the message as is")
		     (?a "Abort")))))
      (cond
       ((eq choice ?a)
	(nnheader-report 'nnimap "Aborted APPEND due to NUL characters"))
       ((eq choice ?c)
	data)
       (t
	(with-temp-buffer
	  (insert data)
	  (goto-char (point-min))
	  (while (search-forward "\000" nil t)
	    (replace-match "" t t))
	  (buffer-string)))))))
1017

1018 1019 1020 1021 1022
(defun nnimap-ok-p (value)
  (and (consp value)
       (consp (car value))
       (equal (caar value) "OK")))

1023
(defun nnimap-find-uid-response (name list)
1024
  (let ((result (car (last (nnimap-find-response-element name list)))))
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
    (and result
	 (string-to-number result))))

(defun nnimap-find-response-element (name list)
  (let (result)
    (dolist (elem list)
      (when (and (consp elem)
		 (equal name (car elem)))
	(setq result elem)))
    result))
1035

1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
(deffoo nnimap-request-replace-article (article group buffer)
  (let (group-art)
    (when (and (nnimap-possibly-change-group group nil)
	       ;; Put the article into the group.
	       (with-current-buffer buffer
		 (setq group-art
		       (nnimap-request-accept-article group nil t))))
      (nnimap-delete-article (list article))
      ;; Return the new article number.
      (cdr group-art))))

1047 1048 1049 1050 1051 1052
(defun nnimap-add-cr ()
  (goto-char (point-min))
  (while (re-search-forward "\r?\n" nil t)
    (replace-match "\r\n" t t)))

(defun nnimap-get-groups ()
1053 1054
  (erase-buffer)
  (let ((sequence (nnimap-send-command "LIST \"\" \"*\""))
1055
	groups)
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
    (nnimap-wait-for-response sequence)
    (subst-char-in-region (point-min) (point-max)
			  ?\\ ?% t)
    (goto-char (point-min))
    (nnimap-unfold-quoted-lines)
    (goto-char (point-min))
    (while (search-forward "* LIST " nil t)
      (let ((flags (read (current-buffer)))
	    (separator (read (current-buffer)))
	    (group (read (current-buffer))))
	(unless (member '%NoSelect flags)
1067 1068 1069 1070
	  (push (if (stringp group)
		    group
		  (format "%s" group))
		groups))))
1071
    (nreverse groups)))
1072

1073
(deffoo nnimap-request-list (&optional server)
1074 1075 1076 1077 1078 1079 1080 1081 1082
  (nnimap-possibly-change-group nil server)
  (with-current-buffer nntp-server-buffer
    (erase-buffer)
    (let ((groups
	   (with-current-buffer (nnimap-buffer)
	     (nnimap-get-groups)))
	  sequences responses)
      (when groups
	(with-current-buffer (nnimap-buffer)
1083
	  (setf (nnimap-group nnimap-object) nil)
1084
	  (dolist (group groups)
1085
	    (setf (nnimap-examined nnimap-object) group)
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
	    (push (list (nnimap-send-command "EXAMINE %S" (utf7-encode group t))
			group)
		  sequences))
	  (nnimap-wait-for-response (caar sequences))
	  (setq responses
		(nnimap-get-responses (mapcar #'car sequences))))
	(dolist (response responses)
	  (let* ((sequence (car response))
		 (response (cadr response))
		 (group (cadr (assoc sequence sequences))))
	    (when (and group
		       (equal (caar response) "OK"))
	      (let ((uidnext (nnimap-find-parameter "UIDNEXT" response))
		    highest exists)
		(dolist (elem response)
		  (when (equal (cadr elem) "EXISTS"