nnimap.el 58.5 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 48 49 50
(require 'nnmail)

(eval-when-compile
  (require 'gnus-sum))
Miles Bader's avatar
Miles Bader committed
51

52 53 54
(autoload 'auth-source-forget-user-or-password "auth-source")
(autoload 'auth-source-user-or-password "auth-source")

Gerd Moellmann's avatar
Gerd Moellmann committed
55 56 57
(nnoo-declare nnimap)

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

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

(defvoo nnimap-stream 'ssl
  "How nnimap will talk to the IMAP server.
67
Values are `ssl', `network', `starttls' or `shell'.")
68 69 70 71 72 73 74 75 76 77

(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.")

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

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

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

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

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

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

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

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

(defvoo nnimap-current-infos nil)

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

116 117 118
(defvar nnimap-process nil)

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

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

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

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

130 131 132
(defvar nnimap-object nil)

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

(defun nnimap-buffer ()
  (nnimap-find-process-buffer nntp-server-buffer))

146 147 148 149 150 151 152 153 154 155
(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))))

156
(deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
Gerd Moellmann's avatar
Gerd Moellmann committed
157
  (with-current-buffer nntp-server-buffer
158 159 160 161 162 163 164 165
    (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))
166
	  (nnimap-header-parameters))
167 168 169 170
	 t)
	(nnimap-transform-headers))
      (insert-buffer-substring
       (nnimap-find-process-buffer (current-buffer))))
171
    'headers))
172 173 174

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

213 214 215 216 217 218 219 220 221
(defun nnimap-unfold-quoted-lines ()
  ;; 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 (delete-region (point) (+ (point) size)))
    (insert (format "%S" string))))

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
(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) ",")))))

242
(deffoo nnimap-open-server (server &optional defs)
Gerd Moellmann's avatar
Gerd Moellmann committed
243 244 245
  (if (nnimap-server-opened server)
      t
    (unless (assq 'nnimap-address defs)
246
      (setq defs (append defs (list (list 'nnimap-address server)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
247
    (nnoo-change-server 'nnimap server defs)
248 249 250 251 252 253 254 255 256 257 258 259
    (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)
260 261
    (set (make-local-variable 'nnimap-object)
	 (make-nnimap :server (nnoo-current-server 'nnimap)))
262
    (push (list buffer (current-buffer)) nnimap-connection-alist)
263
    (push (current-buffer) nnimap-process-buffers)
264 265 266
    (current-buffer)))

(defun nnimap-open-shell-stream (name buffer host port)
267 268 269 270 271 272 273 274
  (let ((process-connection-type nil))
    (start-process name buffer shell-file-name
		   shell-command-switch
		   (format-spec
		    nnimap-shell-program
		    (format-spec-make
		     ?s host
		     ?p port)))))
275

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")))))))

Glenn Morris's avatar
Glenn Morris committed
305 306
(declare-function gnutls-negotiate "gnutls"
		  (proc type &optional priority-string trustfiles keyfiles))
307

308
(defun nnimap-open-connection (buffer)
309 310 311
  (unless nnimap-keepalive-timer
    (setq nnimap-keepalive-timer (run-at-time (* 60 15) (* 60 15)
					      'nnimap-keepalive)))
312 313 314 315 316 317 318
  (block nil
    (with-current-buffer (nnimap-make-process-buffer buffer)
      (let* ((coding-system-for-read 'binary)
	     (coding-system-for-write 'binary)
	     (port nil)
	     (ports
	      (cond
319 320 321
	       ((or (eq nnimap-stream 'network)
		    (and (eq nnimap-stream 'starttls)
			 (fboundp 'open-gnutls-stream)))
322 323
		(nnheader-message 7 "Opening connection to %s..."
				  nnimap-address)
324 325 326 327 328 329 330 331 332
		(open-network-stream
		 "*nnimap*" (current-buffer) nnimap-address
		 (setq port
		       (or nnimap-server-port
			   (if (netrc-find-service-number "imap")
			       "imap"
			     "143"))))
		'("143" "imap"))
	       ((eq nnimap-stream 'shell)
333 334
		(nnheader-message 7 "Opening connection to %s via shell..."
				  nnimap-address)
335 336 337 338 339
		(nnimap-open-shell-stream
		 "*nnimap*" (current-buffer) nnimap-address
		 (setq port (or nnimap-server-port "imap")))
		'("imap"))
	       ((eq nnimap-stream 'starttls)
340
		(nnheader-message 7 "Opening connection to %s via starttls..."
341
			 nnimap-address)
342
		(let ((tls-program
343
		       '("openssl s_client -connect %h:%p -no_ssl2 -ign_eof -starttls imap")))
344 345
		  (open-tls-stream
		   "*nnimap*" (current-buffer) nnimap-address
346
		   (setq port (or nnimap-server-port "imap"))))
347
		'("imap"))
348
	       ((memq nnimap-stream '(ssl tls))
349 350
		(nnheader-message 7 "Opening connection to %s via tls..."
				  nnimap-address)
351
		(funcall (if (fboundp 'open-gnutls-stream)
352 353 354 355 356 357 358 359
			     'open-gnutls-stream
			   'open-tls-stream)
			 "*nnimap*" (current-buffer) nnimap-address
			 (setq port
			       (or nnimap-server-port
				   (if (netrc-find-service-number "imaps")
				       "imaps"
				     "993"))))
360 361 362
		'("143" "993" "imap" "imaps"))
	       (t
		(error "Unknown stream type: %s" nnimap-stream))))
363 364 365 366 367 368 369 370
	     connection-result login-result credentials)
	(setf (nnimap-process nnimap-object)
	      (get-buffer-process (current-buffer)))
	(if (not (and (nnimap-process nnimap-object)
		      (memq (process-status (nnimap-process nnimap-object))
			    '(open run))))
	    (nnheader-report 'nnimap "Unable to contact %s:%s via %s"
			     nnimap-address port nnimap-stream)
371 372
	  (gnus-set-process-query-on-exit-flag
	   (nnimap-process nnimap-object) nil)
373 374 375 376 377 378 379 380
	  (if (not (setq connection-result (nnimap-wait-for-connection)))
	      (nnheader-report 'nnimap
			       "%s" (buffer-substring
				     (point) (line-end-position)))
	    ;; Store the greeting (for debugging purposes).
	    (setf (nnimap-greeting nnimap-object)
		  (buffer-substring (line-beginning-position)
				    (line-end-position)))
381
	    (nnimap-get-capabilities)
382 383
	    (when nnimap-server-port
	      (push (format "%s" nnimap-server-port) ports))
384 385
	    ;; If this is a STARTTLS-capable server, then sever the
	    ;; connection and start a STARTTLS connection instead.
386 387
	    (cond
	     ((and (or (and (eq nnimap-stream 'network)
388
			    (nnimap-capability "STARTTLS"))
389 390 391
		       (eq nnimap-stream 'starttls))
		   (fboundp 'open-gnutls-stream))
	      (nnimap-command "STARTTLS")
392 393 394 395
	      (gnutls-negotiate (nnimap-process nnimap-object) nil)
	      ;; Get the capabilities again -- they may have changed
	      ;; after doing STARTTLS.
	      (nnimap-get-capabilities))
396
	     ((and (eq nnimap-stream 'network)
397
		   (nnimap-capability "STARTTLS"))
398 399 400 401 402 403 404 405 406 407
	      (let ((nnimap-stream 'starttls))
		(let ((tls-process
		       (nnimap-open-connection buffer)))
		  ;; If the STARTTLS connection was successful, we
		  ;; kill our first non-encrypted connection.  If it
		  ;; wasn't successful, we just use our unencrypted
		  ;; connection.
		  (when (memq (process-status tls-process) '(open run))
		    (delete-process (nnimap-process nnimap-object))
		    (kill-buffer (current-buffer))
408
		    (return tls-process))))))
409 410 411 412 413 414 415 416 417 418 419 420 421 422
	    (unless (equal connection-result "PREAUTH")
	      (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)
423
		(setq login-result
424 425
		      (if (and (nnimap-capability "AUTH=PLAIN")
			       (nnimap-capability "LOGINDISABLED"))
426 427 428 429 430 431 432 433 434
			  (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))))
435 436 437 438 439 440 441 442 443 444 445 446
		(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
447
	      (when (nnimap-capability "QRESYNC")
448
		(nnimap-command "ENABLE QRESYNC"))
449 450
	      (nnimap-process nnimap-object))))))))

451 452 453 454 455 456 457
(defun nnimap-get-capabilities ()
  (setf (nnimap-capabilities nnimap-object)
	(mapcar
	 #'upcase
	 (nnimap-find-parameter
	  "CAPABILITY" (cdr (nnimap-command "CAPABILITY"))))))

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

468 469 470 471 472 473 474 475 476 477 478 479
(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))

480
(deffoo nnimap-close-server (&optional server)
481 482 483
  (when (nnoo-change-server 'nnimap server nil)
    (ignore-errors
      (delete-process (get-buffer-process (nnimap-buffer))))
484
    (nnoo-close-server 'nnimap server)
485
    t))
Gerd Moellmann's avatar
Gerd Moellmann committed
486

487
(deffoo nnimap-request-close ()
488
  t)
489

490
(deffoo nnimap-server-opened (&optional server)
491 492 493 494
  (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
495

496
(deffoo nnimap-status-message (&optional server)
497
  nnimap-status-string)
Gerd Moellmann's avatar
Gerd Moellmann committed
498

499
(deffoo nnimap-request-article (article &optional group server to-buffer)
Gerd Moellmann's avatar
Gerd Moellmann committed
500
  (with-current-buffer nntp-server-buffer
501
    (let ((result (nnimap-possibly-change-group group server))
502
	  parts structure)
503 504 505 506 507 508 509
      (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)
510 511 512 513
	  (when nnimap-fetch-partial-articles
	    (nnimap-command "UID FETCH %d (BODYSTRUCTURE)" article)
	    (goto-char (point-min))
	    (when (re-search-forward "FETCH.*BODYSTRUCTURE" nil t)
514 515 516 517
	      (setq structure (ignore-errors
				(let ((start (point)))
				  (forward-sexp 1)
				  (downcase-region start (point))
518
				  (goto-char start)
519
				  (read (current-buffer))))
520
		    parts (nnimap-find-wanted-parts structure))))
521 522 523 524 525 526 527 528 529 530
	  (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)))))))))

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

570 571 572
(defun nnimap-capability (capability)
  (member capability (nnimap-capabilities nnimap-object)))

573
(defun nnimap-ver4-p ()
574
  (nnimap-capability "IMAP4REV1"))
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618

(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)
619 620 621 622 623 624
  (let (type boundary)
    (let ((bstruc structure))
      (while (consp (car bstruc))
	(pop bstruc))
      (setq type (car bstruc))
      (setq bstruc (car (cdr bstruc)))
625 626 627
      (let ((has-boundary (member "boundary" bstruc)))
        (when has-boundary
          (setq boundary (cadr has-boundary)))))
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
    (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")))
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663

(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)
664 665
	  (let ((type (format "%s/%s" (nth 0 sub) (nth 1 sub)))
		(id (if (string= prefix "")
666
			(number-to-string num)
667 668
		      (format "%s.%s" prefix num))))
	    (setcar (nthcdr 9 sub) id)
669 670 671
	    (when (if (eq nnimap-fetch-partial-articles t)
		      (equal id "1")
		    (string-match nnimap-fetch-partial-articles type))
672 673
	      (push id parts))))
	(incf num)))
674
    (nreverse parts)))
675

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

730 731 732
(deffoo nnimap-request-delete-group (group &optional force server)
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
733 734
      (car (nnimap-command "DELETE %S" (utf7-encode group t))))))

735 736 737
(deffoo nnimap-request-rename-group (group new-name &optional server)
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
738
      (nnimap-unselect-group)
739 740
      (car (nnimap-command "RENAME %S %S"
			   (utf7-encode group t) (utf7-encode new-name t))))))
741

742 743 744 745 746 747 748
(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"))

749 750 751 752
(deffoo nnimap-request-expunge-group (group &optional server)
  (when (nnimap-possibly-change-group group server)
    (with-current-buffer (nnimap-buffer)
      (car (nnimap-command "EXPUNGE")))))
753

754 755
(defun nnimap-get-flags (spec)
  (let ((articles nil)
756
	elems end)
757
    (with-current-buffer (nnimap-buffer)
Gerd Moellmann's avatar
Gerd Moellmann committed
758
      (erase-buffer)
759 760
      (nnimap-wait-for-response (nnimap-send-command
				 "UID FETCH %s FLAGS" spec))
761 762 763
      (setq end (point))
      (subst-char-in-region (point-min) (point-max)
			    ?\\ ?% t)
764
      (goto-char (point-min))
765 766 767 768
      (while (search-forward " FETCH " end t)
	(setq elems (read (current-buffer)))
	(push (cons (cadr (memq 'UID elems))
		    (cadr (memq 'FLAGS elems)))
769 770
	      articles)))
    (nreverse articles)))
771

772
(deffoo nnimap-close-group (group &optional server)
773
  t)
Gerd Moellmann's avatar
Gerd Moellmann committed
774

775
(deffoo nnimap-request-move-article (article group server accept-form
776
					     &optional last internal-move-group)
777
  (with-temp-buffer
778
    (mm-disable-multibyte)
779 780 781 782
    (when (funcall (if internal-move-group
		       'nnimap-request-head
		     'nnimap-request-article)
		   article group server (current-buffer))
783 784 785 786 787 788 789 790 791 792
      ;; 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)
793
		(nnimap-delete-article article)
794 795 796 797 798 799 800 801
		(cons internal-move-group
		      (nnimap-find-article-by-message-id
		       internal-move-group message-id))))
	  ;; Move the article to a different method.
	  (let ((result (eval accept-form)))
	    (when result
	      (nnimap-delete-article article)
	      result)))))))
802 803 804

(deffoo nnimap-request-expire-articles (articles group &optional server force)
  (cond
805 806
   ((null articles)
    nil)
807 808
   ((not (nnimap-possibly-change-group group server))
    articles)
809 810
   ((and force
	 (eq nnmail-expiry-target 'delete))
811
    (unless (nnimap-delete-article (gnus-compress-sequence articles))
812
      (nnheader-message 7 "Article marked for deletion, but not expunged."))
813 814
    nil)
   (t
815
    (let ((deletable-articles
816 817
	   (if (or force
		   (eq nnmail-expiry-wait 'immediate))
818 819 820 821 822 823 824
	       articles
	     (gnus-sorted-intersection
	      articles
	      (nnimap-find-expired-articles group)))))
      (if (null deletable-articles)
	  articles
	(if (eq nnmail-expiry-target 'delete)
825
	    (nnimap-delete-article (gnus-compress-sequence deletable-articles))
826 827 828 829 830 831 832 833 834 835 836
	  (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))
    (dolist (article articles)
      (let ((target nnmail-expiry-target))
	(with-temp-buffer
837
          (mm-disable-multibyte)
838
	  (when (nnimap-request-article article group server (current-buffer))
839
	    (nnheader-message 7 "Expiring article %s:%d" group article)
840 841 842 843 844 845 846 847 848 849 850 851 852
	    (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))))))
    ;; Change back to the current group again.
    (nnimap-possibly-change-group group server)
    (setq deleted-articles (nreverse deleted-articles))
853
    (nnimap-delete-article (gnus-compress-sequence deleted-articles))
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
    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))))))))))

872 873

(defun nnimap-find-article-by-message-id (group message-id)
874 875
  (with-current-buffer (nnimap-buffer)
    (erase-buffer)
876 877
    (unless (equal group (nnimap-group nnimap-object))
      (setf (nnimap-group nnimap-object) nil)
878
      (setf (nnimap-examined nnimap-object) group)
879
      (nnimap-send-command "EXAMINE %S" (utf7-encode group t)))
880 881 882 883 884 885 886 887 888 889
    (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))))))
890 891 892 893 894

(defun nnimap-delete-article (articles)
  (with-current-buffer (nnimap-buffer)
    (nnimap-command "UID STORE %s +FLAGS.SILENT (\\Deleted)"
		    (nnimap-article-ranges articles))
895
    (cond
896
     ((nnimap-capability "UIDPLUS")
897 898 899 900 901
      (nnimap-command "UID EXPUNGE %s"
		      (nnimap-article-ranges articles))
      t)
     (nnimap-expunge
      (nnimap-command "EXPUNGE")
902 903 904 905
      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"))))))
906 907 908 909 910

(deffoo nnimap-request-scan (&optional group server)
  (when (and (nnimap-possibly-change-group nil server)
	     nnimap-inbox
	     nnimap-split-methods)
911
    (nnheader-message 7 "nnimap %s splitting mail..." server)
912 913 914 915 916 917 918 919 920
    (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))

921
(deffoo nnimap-request-set-mark (group actions &optional server)
922 923 924
  (when (nnimap-possibly-change-group group server)
    (let (sequence)
      (with-current-buffer (nnimap-buffer)
925
	(erase-buffer)
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
	;; 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)
				(if (eq action 'del)
				    "-"
				  "+")
				(mapconcat #'identity flags " ")))))))
	;; Wait for the last command to complete to avoid later
	;; syncronisation problems with the stream.
941 942
	(when sequence
	  (nnimap-wait-for-response sequence))))))
943

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

975 976 977 978 979 980 981 982 983 984 985
(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))))

986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
(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 ()
  (let ((result (nnimap-command "LIST \"\" \"*\""))
	groups)
    (when (car result)
      (dolist (line (cdr result))
	(when (and (equal (car line) "LIST")
		   (not (and (caadr line)
			     (string-match "noselect" (caadr line)))))
	  (push (car (last line)) groups)))
      (nreverse groups))))

1002
(deffoo nnimap-request-list (&optional server)
1003 1004 1005 1006 1007 1008 1009 1010 1011
  (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)
1012
	  (setf (nnimap-group nnimap-object) nil)
1013
	  (dolist (group groups)
1014
	    (setf (nnimap-examined nnimap-object) group)
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
	    (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
1045 1046
	t))))

1047 1048 1049 1050 1051 1052 1053 1054
(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.
1055 1056
	(insert (format "%S 0 1 y\n" group))))
    t))
1057

1058
(deffoo nnimap-retrieve-group-data-early (server infos)
1059 1060
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
1061 1062
      (erase-buffer)
      (setf (nnimap-group nnimap-object) nil)
1063
      (let ((qresyncp (nnimap-capability "QRESYNC"))
1064
	    params groups sequences active uidvalidity modseq group)
1065 1066 1067
	;; Go through the infos and gather the data needed to know
	;; what and how to request the data.
	(dolist (info infos)
1068 1069 1070 1071 1072
	  (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)))
1073
	  (setf (nnimap-examined nnimap-object) group)