nnimap.el 62.5 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 67
Values are `ssl', `network', `network-only, `starttls' or
`shell'.  The default is to try `ssl' first, and then
`network'.")
68 69 70 71 72 73 74 75

(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
76 77
  "The mail box where incoming mail arrives and should be split out of.
For example, \"INBOX\".")
78

79 80
(defvoo nnimap-split-methods nil
  "How mail is split.
81
Uses the same syntax as `nnmail-split-methods'.")
82

83
(defvoo nnimap-split-fancy nil
84
  "Uses the same syntax as `nnmail-split-fancy'.")
85

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

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

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

96 97 98 99 100
(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.")

101 102 103 104
(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.")
105

106
(defvoo nnimap-connection-alist nil)
107 108 109

(defvoo nnimap-current-infos nil)

110 111 112 113 114 115 116
(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.")

117 118 119
(defvar nnimap-process nil)

(defvar nnimap-status-string "")
120 121 122 123

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

124 125 126
(defvar nnimap-keepalive-timer nil)
(defvar nnimap-process-buffers nil)

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

131 132 133
(defvar nnimap-object nil)

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

144 145 146
(defvar nnimap-quirks
  '(("QRESYNC" "Zimbra" "QRESYNC ")))

147 148
(defvar nnimap-inhibit-logging nil)

149 150 151
(defun nnimap-buffer ()
  (nnimap-find-process-buffer nntp-server-buffer))

152 153 154 155 156 157 158 159 160 161
(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))))

162
(deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
Gerd Moellmann's avatar
Gerd Moellmann committed
163
  (with-current-buffer nntp-server-buffer
164 165 166 167 168 169 170 171
    (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))
172
	  (nnimap-header-parameters))
173
	 t)
174 175
	(nnimap-transform-headers)
	(nnheader-remove-cr-followed-by-lf))
176 177
      (insert-buffer-substring
       (nnimap-find-process-buffer (current-buffer))))
178
    'headers))
179 180 181

(defun nnimap-transform-headers ()
  (goto-char (point-min))
182
  (let (article bytes lines size string)
183 184 185 186 187 188
    (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)))
189
	(setq article (match-string 1))
190 191 192 193 194 195 196 197
	;; 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)))
198
	(setq bytes (nnimap-get-length)
199 200
	      lines nil)
	(beginning-of-line)
201 202 203 204 205 206
	(setq size
	      (and (re-search-forward "RFC822.SIZE \\([0-9]+\\)"
				      (line-end-position)
				      t)
		   (match-string 1)))
	(beginning-of-line)
207
	(when (search-forward "BODYSTRUCTURE" (line-end-position) t)
208 209
	  (let ((structure (ignore-errors
			     (read (current-buffer)))))
210 211 212 213 214 215 216
	    (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)
217 218
	(when size
	  (insert (format "Chars: %s\n" size)))
219 220
	(when lines
	  (insert (format "Lines: %s\n" lines)))
221 222
	(unless (re-search-forward "^\r$" nil t)
	  (goto-char (point-max)))
223 224 225 226
	(delete-region (line-beginning-position) (line-end-position))
	(insert ".")
	(forward-line 1)))))

227 228
(defun nnimap-unfold-quoted-lines ()
  ;; Unfold quoted {number} strings.
229 230 231 232 233 234 235
  (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)))))
236

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
(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) ",")))))

257
(deffoo nnimap-open-server (server &optional defs)
Gerd Moellmann's avatar
Gerd Moellmann committed
258 259 260
  (if (nnimap-server-opened server)
      t
    (unless (assq 'nnimap-address defs)
261
      (setq defs (append defs (list (list 'nnimap-address server)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
262
    (nnoo-change-server 'nnimap server defs)
263 264 265 266 267 268 269 270 271 272 273 274
    (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)
275 276
    (set (make-local-variable 'nnimap-object)
	 (make-nnimap :server (nnoo-current-server 'nnimap)))
277
    (push (list buffer (current-buffer)) nnimap-connection-alist)
278
    (push (current-buffer) nnimap-process-buffers)
279 280
    (current-buffer)))

281
(defun nnimap-credentials (address ports)
282 283 284 285
  (let ((found (nth 0 (auth-source-search :max 1
					  :host address
					  :port ports
					  :create t))))
286
    (if found
287 288 289 290 291
        (list (plist-get found :user)
	      (let ((secret (plist-get found :secret)))
		(if (functionp secret)
		    (funcall secret)
		  secret)))
292
      nil)))
293

294 295 296 297 298 299 300
(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
301
		     (> (gnus-float-time
302 303 304 305 306 307 308
			 (time-subtract
			  now
			  (nnimap-last-command-time nnimap-object)))
			;; More than five minutes since the last command.
			(* 5 60)))
	    (nnimap-send-command "NOOP")))))))

309
(defun nnimap-open-connection (buffer)
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
  ;; 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)
328 329 330
  (unless nnimap-keepalive-timer
    (setq nnimap-keepalive-timer (run-at-time (* 60 15) (* 60 15)
					      'nnimap-keepalive)))
331 332 333 334 335
  (with-current-buffer (nnimap-make-process-buffer buffer)
    (let* ((coding-system-for-read 'binary)
	   (coding-system-for-write 'binary)
	   (port nil)
	   (ports
336
	    (cond
337 338 339 340
	     ((or (eq nnimap-stream 'network)
		  (eq nnimap-stream 'starttls))
	      (nnheader-message 7 "Opening connection to %s..."
				nnimap-address)
341
	      '("imap" "143"))
342 343 344 345 346 347 348
	     ((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)
349
	      '("imaps" "imap" "993" "143"))
350 351 352 353 354
	     (t
	      (error "Unknown stream type: %s" nnimap-stream))))
	   (proto-stream-always-use-starttls t)
           login-result credentials)
      (when nnimap-server-port
355
	(push nnimap-server-port ports))
356
      (destructuring-bind (stream greeting capabilities stream-type)
357
	  (open-protocol-stream
358
	   "*nnimap*" (current-buffer) nnimap-address (car ports)
359 360 361 362 363 364 365 366 367
	   :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)
368
	(setf (nnimap-stream-type nnimap-object) stream-type)
369 370 371 372 373 374 375 376 377 378 379 380 381 382
	(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)
383 384 385 386
	      (if (not (setq credentials
			     (if (eq nnimap-authenticator 'anonymous)
				 (list "anonymous"
				       (message-make-address))
387 388 389
                               ;; Look for the credentials based on
                               ;; the virtual server name and the address
                               (nnimap-credentials
390 391 392 393
				(gnus-delete-duplicates
				 (list
				  nnimap-address
				  (nnoo-current-server 'nnimap)))
394
                                ports))))
395
		  (setq nnimap-object nil)
396 397 398
		(let ((nnimap-inhibit-logging t))
		  (setq login-result
			(nnimap-login (car credentials) (cadr credentials))))
399 400 401 402 403 404
		(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)
405
                      (auth-source-forget+ :host host :port port)))
406 407 408
		  (delete-process (nnimap-process nnimap-object))
		  (setq nnimap-object nil))))
	    (when nnimap-object
409
	      (when (nnimap-capability "QRESYNC")
410
		(nnimap-command "ENABLE QRESYNC"))
411 412
	      (nnimap-process nnimap-object))))))))

413 414 415 416
(autoload 'rfc2104-hash "rfc2104")

(defun nnimap-login (user password)
  (cond
417 418 419 420 421 422
   ;; 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))
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
   ((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)))))))

446 447 448 449 450 451 452 453 454 455
(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)))

456 457 458 459 460 461 462 463 464 465 466 467
(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))

468
(deffoo nnimap-close-server (&optional server)
469 470 471
  (when (nnoo-change-server 'nnimap server nil)
    (ignore-errors
      (delete-process (get-buffer-process (nnimap-buffer))))
472
    (nnoo-close-server 'nnimap server)
473
    t))
Gerd Moellmann's avatar
Gerd Moellmann committed
474

475
(deffoo nnimap-request-close ()
476
  t)
477

478
(deffoo nnimap-server-opened (&optional server)
479 480 481 482
  (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
483

484
(deffoo nnimap-status-message (&optional server)
485
  nnimap-status-string)
Gerd Moellmann's avatar
Gerd Moellmann committed
486

487
(deffoo nnimap-request-article (article &optional group server to-buffer)
Gerd Moellmann's avatar
Gerd Moellmann committed
488
  (with-current-buffer nntp-server-buffer
489
    (let ((result (nnimap-possibly-change-group group server))
490
	  parts structure)
491 492 493 494 495 496 497
      (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)
498 499 500 501
	  (when nnimap-fetch-partial-articles
	    (nnimap-command "UID FETCH %d (BODYSTRUCTURE)" article)
	    (goto-char (point-min))
	    (when (re-search-forward "FETCH.*BODYSTRUCTURE" nil t)
502 503 504 505
	      (setq structure (ignore-errors
				(let ((start (point)))
				  (forward-sexp 1)
				  (downcase-region start (point))
506
				  (goto-char start)
507
				  (read (current-buffer))))
508
		    parts (nnimap-find-wanted-parts structure))))
509 510 511 512 513 514 515 516 517 518
	  (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)))))))))

519 520 521 522 523
(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)))
524 525 526 527 528 529 530 531 532 533 534
      (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)))))))
535 536

(defun nnimap-get-whole-article (article &optional command)
537 538
  (let ((result
	 (nnimap-command
539 540 541 542
	  (or command
	      (if (nnimap-ver4-p)
		  "UID FETCH %d BODY.PEEK[]"
		"UID FETCH %d RFC822.PEEK"))
543 544 545
	  article)))
    ;; Check that we really got an article.
    (goto-char (point-min))
546
    (unless (re-search-forward "\\* [0-9]+ FETCH" nil t)
547 548
      (setq result nil))
    (when result
549 550 551 552
      ;; Remove any data that may have arrived before the FETCH data.
      (beginning-of-line)
      (unless (bobp)
	(delete-region (point-min) (point)))
553 554 555 556 557 558 559
      (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)))

560 561 562
(defun nnimap-capability (capability)
  (member capability (nnimap-capabilities nnimap-object)))

563
(defun nnimap-ver4-p ()
564
  (nnimap-capability "IMAP4REV1"))
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 591 592 593 594 595

(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)
596
	    bytes (or (nnimap-get-length) 0))
597 598 599 600 601 602 603 604 605 606 607 608
      (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)
609 610 611 612 613 614
  (let (type boundary)
    (let ((bstruc structure))
      (while (consp (car bstruc))
	(pop bstruc))
      (setq type (car bstruc))
      (setq bstruc (car (cdr bstruc)))
615 616 617
      (let ((has-boundary (member "boundary" bstruc)))
        (when has-boundary
          (setq boundary (cadr has-boundary)))))
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
    (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")))
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653

(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)
654 655
	  (let ((type (format "%s/%s" (nth 0 sub) (nth 1 sub)))
		(id (if (string= prefix "")
656
			(number-to-string num)
657 658
		      (format "%s.%s" prefix num))))
	    (setcar (nthcdr 9 sub) id)
659 660 661
	    (when (if (eq nnimap-fetch-partial-articles t)
		      (equal id "1")
		    (string-match nnimap-fetch-partial-articles type))
662 663
	      (push id parts))))
	(incf num)))
664
    (nreverse parts)))
665

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

720 721 722
(deffoo nnimap-request-delete-group (group &optional force server)
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
723 724
      (car (nnimap-command "DELETE %S" (utf7-encode group t))))))

725 726 727
(deffoo nnimap-request-rename-group (group new-name &optional server)
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
728
      (nnimap-unselect-group)
729 730
      (car (nnimap-command "RENAME %S %S"
			   (utf7-encode group t) (utf7-encode new-name t))))))
731

732 733 734 735 736 737 738
(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"))

739 740 741 742
(deffoo nnimap-request-expunge-group (group &optional server)
  (when (nnimap-possibly-change-group group server)
    (with-current-buffer (nnimap-buffer)
      (car (nnimap-command "EXPUNGE")))))
743

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

762
(deffoo nnimap-close-group (group &optional server)
763
  t)
Gerd Moellmann's avatar
Gerd Moellmann committed
764

765
(deffoo nnimap-request-move-article (article group server accept-form
766
					     &optional last internal-move-group)
767
  (with-temp-buffer
768
    (mm-disable-multibyte)
769 770 771 772
    (when (funcall (if internal-move-group
		       'nnimap-request-head
		     'nnimap-request-article)
		   article group server (current-buffer))
773 774 775 776 777 778 779 780 781 782
      ;; 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)
783
		(nnimap-delete-article article)
784
		(cons internal-move-group
785 786 787
		      (or (nnimap-find-uid-response "COPYUID" (cadr result))
			  (nnimap-find-article-by-message-id
			   internal-move-group message-id)))))
788 789 790 791 792
	  ;; Move the article to a different method.
	  (let ((result (eval accept-form)))
	    (when result
	      (nnimap-delete-article article)
	      result)))))))
793 794 795

(deffoo nnimap-request-expire-articles (articles group &optional server force)
  (cond
796 797
   ((null articles)
    nil)
798 799
   ((not (nnimap-possibly-change-group group server))
    articles)
800 801
   ((and force
	 (eq nnmail-expiry-target 'delete))
802
    (unless (nnimap-delete-article (gnus-compress-sequence articles))
803
      (nnheader-message 7 "Article marked for deletion, but not expunged."))
804 805
    nil)
   (t
806
    (let ((deletable-articles
807 808
	   (if (or force
		   (eq nnmail-expiry-wait 'immediate))
809 810 811 812 813 814 815
	       articles
	     (gnus-sorted-intersection
	      articles
	      (nnimap-find-expired-articles group)))))
      (if (null deletable-articles)
	  articles
	(if (eq nnmail-expiry-target 'delete)
816
	    (nnimap-delete-article (gnus-compress-sequence deletable-articles))
817 818 819 820 821 822 823 824
	  (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))
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 856 857 858 859 860
    (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))))))))
861 862 863
    ;; Change back to the current group again.
    (nnimap-possibly-change-group group server)
    (setq deleted-articles (nreverse deleted-articles))
864
    (nnimap-delete-article (gnus-compress-sequence deleted-articles))
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
    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))))))))))

883 884

(defun nnimap-find-article-by-message-id (group message-id)
885 886
  (with-current-buffer (nnimap-buffer)
    (erase-buffer)
887 888
    (unless (equal group (nnimap-group nnimap-object))
      (setf (nnimap-group nnimap-object) nil)
889
      (setf (nnimap-examined nnimap-object) group)
890
      (nnimap-send-command "EXAMINE %S" (utf7-encode group t)))
891 892 893 894 895 896 897 898 899 900
    (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))))))
901 902 903 904 905

(defun nnimap-delete-article (articles)
  (with-current-buffer (nnimap-buffer)
    (nnimap-command "UID STORE %s +FLAGS.SILENT (\\Deleted)"
		    (nnimap-article-ranges articles))
906
    (cond
907
     ((nnimap-capability "UIDPLUS")
908 909 910 911 912
      (nnimap-command "UID EXPUNGE %s"
		      (nnimap-article-ranges articles))
      t)
     (nnimap-expunge
      (nnimap-command "EXPUNGE")
913 914 915 916
      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"))))))
917 918 919 920 921

(deffoo nnimap-request-scan (&optional group server)
  (when (and (nnimap-possibly-change-group nil server)
	     nnimap-inbox
	     nnimap-split-methods)
922
    (nnheader-message 7 "nnimap %s splitting mail..." server)
923 924 925 926 927 928 929 930 931
    (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))

932 933 934 935 936 937 938 939 940 941
(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)))))))

942
(deffoo nnimap-request-set-mark (group actions &optional server)
943 944 945
  (when (nnimap-possibly-change-group group server)
    (let (sequence)
      (with-current-buffer (nnimap-buffer)
946
	(erase-buffer)
947 948 949 950 951 952 953 954 955
	;; 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)
956 957
				(cond
				 ((eq action 'del) "-")
958
				 ((eq action 'add) "+")
959
				 ((eq action 'set) ""))
960 961 962
				(mapconcat #'identity flags " ")))))))
	;; Wait for the last command to complete to avoid later
	;; syncronisation problems with the stream.
963 964
	(when sequence
	  (nnimap-wait-for-response sequence))))))
965

Gerd Moellmann's avatar
Gerd Moellmann committed
966
(deffoo nnimap-request-accept-article (group &optional server last)
967 968
  (when (nnimap-possibly-change-group nil server)
    (nnmail-check-syntax)
969 970 971
    (let ((message-id (message-field-value "message-id"))
	  sequence message)
      (nnimap-add-cr)
972
      (setq message (buffer-substring-no-properties (point-min) (point-max)))
973
      (with-current-buffer (nnimap-buffer)
974 975
	(when (setq message (or (nnimap-process-quirk "OK Gimap " 'append message)
				message))
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
	  ;; 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)
1003
	     (string-match greeting-match (nnimap-greeting nnimap-object))
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
	     (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)))))))
1023

1024 1025 1026 1027 1028
(defun nnimap-ok-p (value)
  (and (consp value)
       (consp (car value))
       (equal (caar value) "OK")))

1029
(defun nnimap-find-uid-response (name list)
1030
  (let ((result (car (last (nnimap-find-response-element name list)))))
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
    (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))
1041

1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
(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))))

1053 1054 1055 1056 1057 1058
(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 ()
1059 1060
  (erase-buffer)
  (let ((sequence (nnimap-send-command "LIST \"\" \"*\""))
1061
	groups)
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
    (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)
1073 1074