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

3
;; Copyright (C) 2010 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 52
(autoload 'auth-source-forget-user-or-password "auth-source")
(autoload 'auth-source-user-or-password "auth-source")

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)
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 170 171 172
	 t)
	(nnimap-transform-headers))
      (insert-buffer-substring
       (nnimap-find-process-buffer (current-buffer))))
173
    'headers))
174 175 176

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

222 223
(defun nnimap-unfold-quoted-lines ()
  ;; Unfold quoted {number} strings.
224 225 226 227 228 229 230
  (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)))))
231

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
(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) ",")))))

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

276
(defun nnimap-credentials (address ports &optional inhibit-create)
277 278 279 280 281 282 283
  (let (port credentials)
    ;; Request the credentials from all ports, but only query on the
    ;; last port if all the previous ones have failed.
    (while (and (null credentials)
		(setq port (pop ports)))
      (setq credentials
	    (auth-source-user-or-password
284 285 286 287
	     '("login" "password") address port nil
	     (if inhibit-create
		 nil
	       (null ports)))))
288 289
    credentials))

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

305
(defun nnimap-open-connection (buffer)
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
  ;; 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)
324 325 326
  (unless nnimap-keepalive-timer
    (setq nnimap-keepalive-timer (run-at-time (* 60 15) (* 60 15)
					      'nnimap-keepalive)))
327 328 329 330 331
  (with-current-buffer (nnimap-make-process-buffer buffer)
    (let* ((coding-system-for-read 'binary)
	   (coding-system-for-write 'binary)
	   (port nil)
	   (ports
332
	    (cond
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
	     ((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))))
      (destructuring-bind (stream greeting capabilities)
	  (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)
	(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)
378 379 380 381 382 383 384 385 386 387 388 389 390
	      (if (not (setq credentials
			     (if (eq nnimap-authenticator 'anonymous)
				 (list "anonymous"
				       (message-make-address))
			       (or
				;; First look for the credentials based
				;; on the virtual server name.
				(nnimap-credentials
				 (nnoo-current-server 'nnimap) ports t)
				;; Then look them up based on the
				;; physical address.
				(nnimap-credentials nnimap-address ports)))))
		  (setq nnimap-object nil)
391
		(setq login-result
392 393
		      (if (and (nnimap-capability "AUTH=PLAIN")
			       (nnimap-capability "LOGINDISABLED"))
394 395 396 397 398 399 400 401 402
			  (nnimap-command
			   "AUTHENTICATE PLAIN %s"
			   (base64-encode-string
			    (format "\000%s\000%s"
				    (nnimap-quote-specials (car credentials))
				    (nnimap-quote-specials (cadr credentials)))))
			(nnimap-command "LOGIN %S %S"
					(car credentials)
					(cadr credentials))))
403 404 405 406 407 408 409 410 411 412 413 414
		(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)
		      (dolist (element '("login" "password"))
			(auth-source-forget-user-or-password
			 element host port))))
		  (delete-process (nnimap-process nnimap-object))
		  (setq nnimap-object nil))))
	    (when nnimap-object
415
	      (when (nnimap-capability "QRESYNC")
416
		(nnimap-command "ENABLE QRESYNC"))
417 418
	      (nnimap-process nnimap-object))))))))

419 420 421 422 423 424 425 426 427 428
(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)))

429 430 431 432 433 434 435 436 437 438 439 440
(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))

441
(deffoo nnimap-close-server (&optional server)
442 443 444
  (when (nnoo-change-server 'nnimap server nil)
    (ignore-errors
      (delete-process (get-buffer-process (nnimap-buffer))))
445
    (nnoo-close-server 'nnimap server)
446
    t))
Gerd Moellmann's avatar
Gerd Moellmann committed
447

448
(deffoo nnimap-request-close ()
449
  t)
450

451
(deffoo nnimap-server-opened (&optional server)
452 453 454 455
  (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
456

457
(deffoo nnimap-status-message (&optional server)
458
  nnimap-status-string)
Gerd Moellmann's avatar
Gerd Moellmann committed
459

460
(deffoo nnimap-request-article (article &optional group server to-buffer)
Gerd Moellmann's avatar
Gerd Moellmann committed
461
  (with-current-buffer nntp-server-buffer
462
    (let ((result (nnimap-possibly-change-group group server))
463
	  parts structure)
464 465 466 467 468 469 470
      (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)
471 472 473 474
	  (when nnimap-fetch-partial-articles
	    (nnimap-command "UID FETCH %d (BODYSTRUCTURE)" article)
	    (goto-char (point-min))
	    (when (re-search-forward "FETCH.*BODYSTRUCTURE" nil t)
475 476 477 478
	      (setq structure (ignore-errors
				(let ((start (point)))
				  (forward-sexp 1)
				  (downcase-region start (point))
479
				  (goto-char start)
480
				  (read (current-buffer))))
481
		    parts (nnimap-find-wanted-parts structure))))
482 483 484 485 486 487 488 489 490 491
	  (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)))))))))

492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
(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)))
      (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))))))

(defun nnimap-get-whole-article (article &optional command)
508 509
  (let ((result
	 (nnimap-command
510 511 512 513
	  (or command
	      (if (nnimap-ver4-p)
		  "UID FETCH %d BODY.PEEK[]"
		"UID FETCH %d RFC822.PEEK"))
514 515 516
	  article)))
    ;; Check that we really got an article.
    (goto-char (point-min))
517
    (unless (re-search-forward "\\* [0-9]+ FETCH" nil t)
518 519
      (setq result nil))
    (when result
520 521 522 523
      ;; Remove any data that may have arrived before the FETCH data.
      (beginning-of-line)
      (unless (bobp)
	(delete-region (point-min) (point)))
524 525 526 527 528 529 530
      (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)))

531 532 533
(defun nnimap-capability (capability)
  (member capability (nnimap-capabilities nnimap-object)))

534
(defun nnimap-ver4-p ()
535
  (nnimap-capability "IMAP4REV1"))
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579

(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)
	    bytes (nnimap-get-length))
      (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)
580 581 582 583 584 585
  (let (type boundary)
    (let ((bstruc structure))
      (while (consp (car bstruc))
	(pop bstruc))
      (setq type (car bstruc))
      (setq bstruc (car (cdr bstruc)))
586 587 588
      (let ((has-boundary (member "boundary" bstruc)))
        (when has-boundary
          (setq boundary (cadr has-boundary)))))
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
    (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")))
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624

(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)
625 626
	  (let ((type (format "%s/%s" (nth 0 sub) (nth 1 sub)))
		(id (if (string= prefix "")
627
			(number-to-string num)
628 629
		      (format "%s.%s" prefix num))))
	    (setcar (nthcdr 9 sub) id)
630 631 632
	    (when (if (eq nnimap-fetch-partial-articles t)
		      (equal id "1")
		    (string-match nnimap-fetch-partial-articles type))
633 634
	      (push id parts))))
	(incf num)))
635
    (nreverse parts)))
636

637
(deffoo nnimap-request-group (group &optional server dont-check info)
638 639 640
  (let ((result (nnimap-possibly-change-group
		 ;; Don't SELECT the group if we're going to select it
		 ;; later, anyway.
641 642
		 (if (and dont-check
			  (assoc group nnimap-current-infos))
643 644 645
		     nil
		   group)
		 server))
646 647
	articles active marks high low)
    (with-current-buffer nntp-server-buffer
648
      (when result
649 650 651 652 653 654 655 656 657 658
	(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
659
		   (nnimap-send-command "SELECT %S" (utf7-encode group t)))
660 661
		  (flag-sequence
		   (nnimap-send-command "UID FETCH 1:* FLAGS")))
662
	      (setf (nnimap-group nnimap-object) group)
663 664 665 666
	      (nnimap-wait-for-response flag-sequence)
	      (setq marks
		    (nnimap-flags-to-marks
		     (nnimap-parse-flags
667 668 669 670
		      (list (list group-sequence flag-sequence
				  1 group "SELECT")))))
	      (when (and info
			 marks)
671 672
		(nnimap-update-infos marks (list info))
		(nnimap-store-info info (gnus-active (gnus-info-group info))))
673
	      (goto-char (point-max))
674
	      (let ((uidnext (nth 5 (car marks))))
675 676 677 678 679
		(setq high (or (if uidnext
                                   (1- uidnext)
                                 (nth 3 (car marks)))
                               0)
		      low (or (nth 4 (car marks)) uidnext 1)))))
680 681 682
	  (erase-buffer)
	  (insert
	   (format
683 684 685 686 687 688 689
	    "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
690

691 692 693
(deffoo nnimap-request-delete-group (group &optional force server)
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
694 695
      (car (nnimap-command "DELETE %S" (utf7-encode group t))))))

696 697 698
(deffoo nnimap-request-rename-group (group new-name &optional server)
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
699
      (nnimap-unselect-group)
700 701
      (car (nnimap-command "RENAME %S %S"
			   (utf7-encode group t) (utf7-encode new-name t))))))
702

703 704 705 706 707 708 709
(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"))

710 711 712 713
(deffoo nnimap-request-expunge-group (group &optional server)
  (when (nnimap-possibly-change-group group server)
    (with-current-buffer (nnimap-buffer)
      (car (nnimap-command "EXPUNGE")))))
714

715 716
(defun nnimap-get-flags (spec)
  (let ((articles nil)
717
	elems end)
718
    (with-current-buffer (nnimap-buffer)
Gerd Moellmann's avatar
Gerd Moellmann committed
719
      (erase-buffer)
720 721
      (nnimap-wait-for-response (nnimap-send-command
				 "UID FETCH %s FLAGS" spec))
722 723 724
      (setq end (point))
      (subst-char-in-region (point-min) (point-max)
			    ?\\ ?% t)
725
      (goto-char (point-min))
726 727 728 729
      (while (search-forward " FETCH " end t)
	(setq elems (read (current-buffer)))
	(push (cons (cadr (memq 'UID elems))
		    (cadr (memq 'FLAGS elems)))
730 731
	      articles)))
    (nreverse articles)))
732

733
(deffoo nnimap-close-group (group &optional server)
734
  t)
Gerd Moellmann's avatar
Gerd Moellmann committed
735

736
(deffoo nnimap-request-move-article (article group server accept-form
737
					     &optional last internal-move-group)
738
  (with-temp-buffer
739
    (mm-disable-multibyte)
740 741 742 743
    (when (funcall (if internal-move-group
		       'nnimap-request-head
		     'nnimap-request-article)
		   article group server (current-buffer))
744 745 746 747 748 749 750 751 752 753
      ;; 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)
754
		(nnimap-delete-article article)
755
		(cons internal-move-group
756 757 758
		      (or (nnimap-find-uid-response "COPYUID" (cadr result))
			  (nnimap-find-article-by-message-id
			   internal-move-group message-id)))))
759 760 761 762 763
	  ;; Move the article to a different method.
	  (let ((result (eval accept-form)))
	    (when result
	      (nnimap-delete-article article)
	      result)))))))
764 765 766

(deffoo nnimap-request-expire-articles (articles group &optional server force)
  (cond
767 768
   ((null articles)
    nil)
769 770
   ((not (nnimap-possibly-change-group group server))
    articles)
771 772
   ((and force
	 (eq nnmail-expiry-target 'delete))
773
    (unless (nnimap-delete-article (gnus-compress-sequence articles))
774
      (nnheader-message 7 "Article marked for deletion, but not expunged."))
775 776
    nil)
   (t
777
    (let ((deletable-articles
778 779
	   (if (or force
		   (eq nnmail-expiry-wait 'immediate))
780 781 782 783 784 785 786
	       articles
	     (gnus-sorted-intersection
	      articles
	      (nnimap-find-expired-articles group)))))
      (if (null deletable-articles)
	  articles
	(if (eq nnmail-expiry-target 'delete)
787
	    (nnimap-delete-article (gnus-compress-sequence deletable-articles))
788 789 790 791 792 793 794 795
	  (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))
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
    (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))))))))
832 833 834
    ;; Change back to the current group again.
    (nnimap-possibly-change-group group server)
    (setq deleted-articles (nreverse deleted-articles))
835
    (nnimap-delete-article (gnus-compress-sequence deleted-articles))
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
    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))))))))))

854 855

(defun nnimap-find-article-by-message-id (group message-id)
856 857
  (with-current-buffer (nnimap-buffer)
    (erase-buffer)
858 859
    (unless (equal group (nnimap-group nnimap-object))
      (setf (nnimap-group nnimap-object) nil)
860
      (setf (nnimap-examined nnimap-object) group)
861
      (nnimap-send-command "EXAMINE %S" (utf7-encode group t)))
862 863 864 865 866 867 868 869 870 871
    (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))))))
872 873 874 875 876

(defun nnimap-delete-article (articles)
  (with-current-buffer (nnimap-buffer)
    (nnimap-command "UID STORE %s +FLAGS.SILENT (\\Deleted)"
		    (nnimap-article-ranges articles))
877
    (cond
878
     ((nnimap-capability "UIDPLUS")
879 880 881 882 883
      (nnimap-command "UID EXPUNGE %s"
		      (nnimap-article-ranges articles))
      t)
     (nnimap-expunge
      (nnimap-command "EXPUNGE")
884 885 886 887
      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"))))))
888 889 890 891 892

(deffoo nnimap-request-scan (&optional group server)
  (when (and (nnimap-possibly-change-group nil server)
	     nnimap-inbox
	     nnimap-split-methods)
893
    (nnheader-message 7 "nnimap %s splitting mail..." server)
894 895 896 897 898 899 900 901 902
    (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))

903 904 905 906 907 908 909 910 911 912
(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)))))))

913
(deffoo nnimap-request-set-mark (group actions &optional server)
914 915 916
  (when (nnimap-possibly-change-group group server)
    (let (sequence)
      (with-current-buffer (nnimap-buffer)
917
	(erase-buffer)
918 919 920 921 922 923 924 925 926
	;; 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)
927 928
				(cond
				 ((eq action 'del) "-")
929
				 ((eq action 'add) "+")
930
				 ((eq action 'set) ""))
931 932 933
				(mapconcat #'identity flags " ")))))))
	;; Wait for the last command to complete to avoid later
	;; syncronisation problems with the stream.
934 935
	(when sequence
	  (nnimap-wait-for-response sequence))))))
936

Gerd Moellmann's avatar
Gerd Moellmann committed
937
(deffoo nnimap-request-accept-article (group &optional server last)
938 939
  (when (nnimap-possibly-change-group nil server)
    (nnmail-check-syntax)
940 941 942
    (let ((message-id (message-field-value "message-id"))
	  sequence message)
      (nnimap-add-cr)
943
      (setq message (buffer-substring-no-properties (point-min) (point-max)))
944
      (with-current-buffer (nnimap-buffer)
945 946 947 948
	;; 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))
949
	(erase-buffer)
950 951 952
	(setq sequence (nnimap-send-command
			"APPEND %S {%d}" (utf7-encode group t)
			(length message)))
953 954
	(unless nnimap-streaming
	  (nnimap-wait-for-connection "^[+]"))
955
	(process-send-string (get-buffer-process (current-buffer)) message)
956 957 958 959
	(process-send-string (get-buffer-process (current-buffer))
			     (if (nnimap-newlinep nnimap-object)
				 "\n"
			       "\r\n"))
960
	(let ((result (nnimap-get-response sequence)))
961 962
	  (if (not (car result))
	      (progn
963
		(nnheader-message 7 "%s" (nnheader-get-report-string 'nnimap))
964
		nil)
965
	    (cons group
966 967 968 969 970
		  (or (nnimap-find-uid-response "APPENDUID" (car result))
		      (nnimap-find-article-by-message-id
		       group message-id)))))))))

(defun nnimap-find-uid-response (name list)
971
  (let ((result (car (last (nnimap-find-response-element name list)))))
972 973 974 975 976 977 978 979 980 981
    (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))
982

983 984 985 986 987 988 989 990 991 992 993
(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))))

994 995 996 997 998 999
(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 ()
1000 1001
  (erase-buffer)
  (let ((sequence (nnimap-send-command "LIST \"\" \"*\""))
1002
	groups)
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
    (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)
1014 1015 1016 1017
	  (push (if (stringp group)
		    group
		  (format "%s" group))
		groups))))
1018
    (nreverse groups)))
1019

1020
(deffoo nnimap-request-list (&optional server)
1021 1022 1023 1024 1025 1026 1027 1028 1029
  (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)
1030
	  (setf (nnimap-group nnimap-object) nil)
1031
	  (dolist (group groups)
1032
	    (setf (nnimap-examined nnimap-object) group)
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
	    (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")
		    (setq exists (string-to-number (car elem)))))
		(when uidnext
		  (setq highest (1- (string-to-number (car uidnext)))))
		(cond
		 ((null highest)
		  (insert (format "%S 0 1 y\n" (utf7-decode group t))))
		 ((zerop exists)
		  ;; Empty group.
		  (insert (format "%S %d %d y\n"
				  (utf7-decode group t) highest (1+ highest))))
		 (t
		  ;; Return the widest possible range.
		  (insert (format "%S %d 1 y\n" (utf7-decode group t)
				  (or highest exists)))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1063 1064
	t))))

1065 1066 1067 1068 1069 1070 1071 1072
(deffoo nnimap-request-newgroups (date &optional server)
  (nnimap-possibly-change-group nil server)
  (with-current-buffer nntp-server-buffer
    (erase-buffer)
    (dolist (group (with-current-buffer (nnimap-buffer)
		     (nnimap-get-groups)))
      (unless (assoc group nnimap-current-infos)
	;; Insert dummy numbers here -- they don't matter.
1073 1074
	(insert (format "%S 0 1 y\n" group))))
    t))
1075

1076
(deffoo nnimap-retrieve-group-data-early (server infos)
1077 1078
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
1079 1080
      (erase-buffer)
      (setf (nnimap-group nnimap-object) nil)
1081
      (let ((qresyncp (nnimap-capability "QRESYNC"))
1082
	    params groups sequences active uidvalidity modseq group)
1083 1084 1085
	;; Go through the infos and gather the data needed to know
	;; what and how to request the data.
	(dolist (info infos)
1086 1087 1088 1089 1090
	  (setq params (gnus-info-params info)
		group (gnus-group-real-name (gnus-info-group info))
		active (cdr (assq 'active params))
		uidvalidity (cdr (assq 'uidvalidity params))
		modseq (cdr (assq 'modseq params)))
1091
	  (setf (nnimap-examined nnimap-object) group)
1092
	  (if (and qresyncp
1093 1094
		   uidvalidity
		   modseq)
Katsumi Yamaoka's avatar