nnimap.el 57.2 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)
Miles Bader's avatar
Miles Bader committed
47

48 49 50
(autoload 'auth-source-forget-user-or-password "auth-source")
(autoload 'auth-source-user-or-password "auth-source")

Gerd Moellmann's avatar
Gerd Moellmann committed
51 52 53
(nnoo-declare nnimap)

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

(defvoo nnimap-server-port nil
57 58 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'.")

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

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

74 75 76 77
(defvoo nnimap-split-methods nil
  "How mail is split.
Uses the same syntax as nnmail-split-methods")

78 79 80
(defvoo nnimap-split-fancy nil
  "Uses the same syntax as nnmail-split-fancy.")

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

84
(make-obsolete-variable 'nnimap-split-rule "see `nnimap-split-methods'"
85
			"Emacs 24.1")
86

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

91 92 93 94 95
(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.")

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

101
(defvoo nnimap-connection-alist nil)
102 103 104

(defvoo nnimap-current-infos nil)

105 106 107 108 109 110 111
(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.")

112 113 114
(defvar nnimap-process nil)

(defvar nnimap-status-string "")
115 116 117 118

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

119 120 121
(defvar nnimap-keepalive-timer nil)
(defvar nnimap-process-buffers nil)

122
(defstruct nnimap
123
  group process commands capabilities select-result newlinep server
124
  last-command-time greeting)
Gerd Moellmann's avatar
Gerd Moellmann committed
125

126 127 128
(defvar nnimap-object nil)

(defvar nnimap-mark-alist
129 130 131
  '((read "\\Seen" %Seen)
    (tick "\\Flagged" %Flagged)
    (reply "\\Answered" %Answered)
132 133 134 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")))

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

142 143 144 145 146 147 148 149 150 151
(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))))

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

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

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

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

(defun nnimap-open-shell-stream (name buffer host port)
260 261 262 263 264 265 266 267
  (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)))))
268

269
(defun nnimap-credentials (address ports &optional inhibit-create)
270 271 272 273 274 275 276
  (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
277 278 279 280
	     '("login" "password") address port nil
	     (if inhibit-create
		 nil
	       (null ports)))))
281 282
    credentials))

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
(defun nnimap-keepalive ()
  (let ((now (current-time)))
    (dolist (buffer nnimap-process-buffers)
      (when (buffer-name buffer)
	(with-current-buffer buffer
	  (when (and nnimap-object
		     (nnimap-last-command-time nnimap-object)
		     (> (time-to-seconds
			 (time-subtract
			  now
			  (nnimap-last-command-time nnimap-object)))
			;; More than five minutes since the last command.
			(* 5 60)))
	    (nnimap-send-command "NOOP")))))))

298 299
(declare-function gnutls-negotiate "subr" (fn file &optional arglist fileonly))

300
(defun nnimap-open-connection (buffer)
301 302 303
  (unless nnimap-keepalive-timer
    (setq nnimap-keepalive-timer (run-at-time (* 60 15) (* 60 15)
					      'nnimap-keepalive)))
304 305 306 307 308 309 310
  (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
311 312 313
	       ((or (eq nnimap-stream 'network)
		    (and (eq nnimap-stream 'starttls)
			 (fboundp 'open-gnutls-stream)))
314 315
		(nnheader-message 7 "Opening connection to %s..."
				  nnimap-address)
316 317 318 319 320 321 322 323 324
		(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)
325 326
		(nnheader-message 7 "Opening connection to %s via shell..."
				  nnimap-address)
327 328 329 330 331
		(nnimap-open-shell-stream
		 "*nnimap*" (current-buffer) nnimap-address
		 (setq port (or nnimap-server-port "imap")))
		'("imap"))
	       ((eq nnimap-stream 'starttls)
332
		(nnheader-message 7 "Opening connection to %s via starttls..."
333
			 nnimap-address)
334
		(let ((tls-program
335
		       '("openssl s_client -connect %h:%p -no_ssl2 -ign_eof -starttls imap")))
336 337
		  (open-tls-stream
		   "*nnimap*" (current-buffer) nnimap-address
338
		   (setq port (or nnimap-server-port "imap"))))
339
		'("imap"))
340
	       ((memq nnimap-stream '(ssl tls))
341 342
		(nnheader-message 7 "Opening connection to %s via tls..."
				  nnimap-address)
343
		(funcall (if (fboundp 'open-gnutls-stream)
344 345 346 347 348 349 350 351
			     '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"))))
352 353 354
		'("143" "993" "imap" "imaps"))
	       (t
		(error "Unknown stream type: %s" nnimap-stream))))
355 356 357 358 359 360 361 362
	     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)
363 364
	  (gnus-set-process-query-on-exit-flag
	   (nnimap-process nnimap-object) nil)
365 366 367 368 369 370 371 372 373
	  (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)))
	    ;; Store the capabilities.
374 375 376
	    (setf (nnimap-capabilities nnimap-object)
		  (mapcar
		   #'upcase
377 378 379 380
		   (nnimap-find-parameter
		    "CAPABILITY" (cdr (nnimap-command "CAPABILITY")))))
	    (when nnimap-server-port
	      (push (format "%s" nnimap-server-port) ports))
381 382
	    ;; If this is a STARTTLS-capable server, then sever the
	    ;; connection and start a STARTTLS connection instead.
383 384 385 386 387 388 389 390 391 392
	    (cond
	     ((and (or (and (eq nnimap-stream 'network)
			    (member "STARTTLS"
				    (nnimap-capabilities nnimap-object)))
		       (eq nnimap-stream 'starttls))
		   (fboundp 'open-gnutls-stream))
	      (nnimap-command "STARTTLS")
	      (gnutls-negotiate (nnimap-process nnimap-object) nil))
	     ((and (eq nnimap-stream 'network)
		   (member "STARTTLS" (nnimap-capabilities nnimap-object)))
393 394 395 396 397 398 399 400 401 402
	      (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))
403
		    (return tls-process))))))
404 405 406 407 408 409 410 411 412 413 414 415 416 417
	    (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)
418 419 420 421 422 423 424 425 426 427 428 429
		(setq login-result
		      (if (member "AUTH=PLAIN"
				  (nnimap-capabilities nnimap-object))
			  (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))))
430 431 432 433 434 435 436 437 438 439 440 441 442 443
		(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
	      (when (member "QRESYNC" (nnimap-capabilities nnimap-object))
		(nnimap-command "ENABLE QRESYNC"))
444 445
	      (nnimap-process nnimap-object))))))))

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 524 525 526 527 528 529 530 531 532 533 534
(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)
535 536
  (let ((result
	 (nnimap-command
537 538 539 540
	  (or command
	      (if (nnimap-ver4-p)
		  "UID FETCH %d BODY.PEEK[]"
		"UID FETCH %d RFC822.PEEK"))
541 542 543
	  article)))
    ;; Check that we really got an article.
    (goto-char (point-min))
544
    (unless (re-search-forward "\\* [0-9]+ FETCH" nil t)
545 546
      (setq result nil))
    (when result
547 548 549 550
      ;; Remove any data that may have arrived before the FETCH data.
      (beginning-of-line)
      (unless (bobp)
	(delete-region (point-min) (point)))
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 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
      (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)))

(defun nnimap-ver4-p ()
  (member "IMAP4REV1" (nnimap-capabilities nnimap-object)))

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

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

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

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

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

718 719 720
(deffoo nnimap-request-rename-group (group new-name &optional server)
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
721 722 723 724 725
      ;; 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")
726
      (setf (nnimap-group nnimap-object) nil)
727 728
      (car (nnimap-command "RENAME %S %S"
			   (utf7-encode group t) (utf7-encode new-name t))))))
729

730 731 732 733
(deffoo nnimap-request-expunge-group (group &optional server)
  (when (nnimap-possibly-change-group group server)
    (with-current-buffer (nnimap-buffer)
      (car (nnimap-command "EXPUNGE")))))
734

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

753
(deffoo nnimap-close-group (group &optional server)
754
  t)
Gerd Moellmann's avatar
Gerd Moellmann committed
755

756
(deffoo nnimap-request-move-article (article group server accept-form
757
					     &optional last internal-move-group)
758
  (with-temp-buffer
759
    (mm-disable-multibyte)
760 761 762 763
    (when (funcall (if internal-move-group
		       'nnimap-request-head
		     'nnimap-request-article)
		   article group server (current-buffer))
764 765 766 767 768 769 770 771 772 773
      ;; 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)
774
		(nnimap-delete-article article)
775 776 777 778 779 780 781 782
		(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)))))))
783 784 785

(deffoo nnimap-request-expire-articles (articles group &optional server force)
  (cond
786 787
   ((null articles)
    nil)
788 789
   ((not (nnimap-possibly-change-group group server))
    articles)
790 791
   ((and force
	 (eq nnmail-expiry-target 'delete))
792
    (unless (nnimap-delete-article (gnus-compress-sequence articles))
793
      (nnheader-message 7 "Article marked for deletion, but not expunged."))
794 795
    nil)
   (t
796
    (let ((deletable-articles
797 798
	   (if (or force
		   (eq nnmail-expiry-wait 'immediate))
799 800 801 802 803 804 805
	       articles
	     (gnus-sorted-intersection
	      articles
	      (nnimap-find-expired-articles group)))))
      (if (null deletable-articles)
	  articles
	(if (eq nnmail-expiry-target 'delete)
806
	    (nnimap-delete-article (gnus-compress-sequence deletable-articles))
807 808 809 810 811 812 813 814 815 816 817
	  (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
818
          (mm-disable-multibyte)
819
	  (when (nnimap-request-article article group server (current-buffer))
820
	    (nnheader-message 7 "Expiring article %s:%d" group article)
821 822 823 824 825 826 827 828 829 830 831 832 833
	    (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))
834
    (nnimap-delete-article (gnus-compress-sequence deleted-articles))
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
    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))))))))))

853 854

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

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

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

900
(deffoo nnimap-request-set-mark (group actions &optional server)
901 902 903
  (when (nnimap-possibly-change-group group server)
    (let (sequence)
      (with-current-buffer (nnimap-buffer)
904
	(erase-buffer)
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
	;; 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.
920 921
	(when sequence
	  (nnimap-wait-for-response sequence))))))
922

Gerd Moellmann's avatar
Gerd Moellmann committed
923
(deffoo nnimap-request-accept-article (group &optional server last)
924 925
  (when (nnimap-possibly-change-group nil server)
    (nnmail-check-syntax)
926 927 928
    (let ((message-id (message-field-value "message-id"))
	  sequence message)
      (nnimap-add-cr)
929
      (setq message (buffer-substring-no-properties (point-min) (point-max)))
930 931 932 933 934
      (with-current-buffer (nnimap-buffer)
	(setq sequence (nnimap-send-command
			"APPEND %S {%d}" (utf7-encode group t)
			(length message)))
	(process-send-string (get-buffer-process (current-buffer)) message)
935 936 937 938
	(process-send-string (get-buffer-process (current-buffer))
			     (if (nnimap-newlinep nnimap-object)
				 "\n"
			       "\r\n"))
939
	(let ((result (nnimap-get-response sequence)))
940 941
	  (if (not (car result))
	      (progn
942
		(nnheader-message 7 "%s" (nnheader-get-report-string 'nnimap))
943
		nil)
944 945 946
	    (cons group
		  (nnimap-find-article-by-message-id group message-id))))))))

947 948 949 950 951 952 953 954 955 956 957
(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))))

958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
(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))))

974
(deffoo nnimap-request-list (&optional server)
975 976 977 978 979 980 981 982 983
  (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)
984
	  (setf (nnimap-group nnimap-object) nil)
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
	  (dolist (group groups)
	    (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
1016 1017
	t))))

1018 1019 1020 1021 1022 1023 1024 1025
(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.
1026 1027
	(insert (format "%S 0 1 y\n" group))))
    t))
1028

1029
(deffoo nnimap-retrieve-group-data-early (server infos)
1030 1031
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
1032 1033
      (erase-buffer)
      (setf (nnimap-group nnimap-object) nil)
1034
      (let ((qresyncp (member "QRESYNC" (nnimap-capabilities nnimap-object)))
1035
	    params groups sequences active uidvalidity modseq group)
1036 1037 1038
	;; Go through the infos and gather the data needed to know
	;; what and how to request the data.
	(dolist (info infos)
1039 1040 1041 1042 1043
	  (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)))
1044
	  (if (and qresyncp
1045 1046
		   uidvalidity
		   modseq)
1047
	      (push
1048
	       (list (nnimap-send-command "EXAMINE %S (QRESYNC (%s %s))"
1049 1050
					  (utf7-encode group t)
					  uidvalidity modseq)
1051 1052
		     'qresync
		     nil group 'qresync)
1053 1054
	       sequences)
	    (let ((start
1055
		   (if (and active uidvalidity)
1056
		       ;; Fetch the last 100 flags.
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
		       (max 1 (- (cdr active) 100))
		     1))
		  (command
		   (if uidvalidity
		       "EXAMINE"
		     ;; If we don't have a UIDVALIDITY, then this is
		     ;; the first time we've seen the group, so we
		     ;; have to do a SELECT (which is slower than an
		     ;; examine), but will tell us whether the group
		     ;; is read-only or not.
		     "SELECT")))
1068 1069
	      (push (list (nnimap-send-command "%s %S" command
					       (utf7-encode group t))
1070
			  (nnimap-send-command "UID FETCH %d:* FLAGS" start)
1071
			  start group command)
1072
		    sequences))))
1073 1074
	sequences))))

1075
(deffoo nnimap-finish-retrieve-group-infos (server infos sequences)
1076 1077 1078 1079
  (when (and sequences
	     (nnimap-possibly-change-group nil server))
    (with-current-buffer (nnimap-buffer)
      ;; Wait for the final data to trickle in.
1080 1081 1082 1083 1084 1085 1086
      (when (nnimap-wait-for-response (if (eq (cadar sequences) 'qresync)
					  (caar sequences)
					(cadar sequences))
				      t)
	;; Now we should have most of the data we need, no matter
	;; whether we're QRESYNCING, fetching all the flags from
	;; scratch, or just fetching the last 100 flags per group.
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
	(nnimap-update-infos (nnimap-flags-to-marks
			      (nnimap-parse-flags
			       (nreverse sequences)))
			     infos)
	;; Finally, just return something resembling an active file in
	;; the nntp buffer, so that the agent can save the info, too.
	(with-current-buffer nntp-server-buffer
	  (erase-buffer)
	  (dolist (info infos)
	    (let* ((group (gnus-info-group info))
		   (active (gnus-active group)))
	      (when active
		(insert (format "%S %d %d y\n"
				(gnus-group-real-name group)
				(cdr active)
				(car active)))))))))))
1103 1104 1105

(defun nnimap-update-infos (flags infos)
  (dolist (info infos)
1106 1107 1108 1109
    (let* ((group (gnus-group-real-name (gnus-info-group info)))
	   (marks (cdr (assoc group flags))))
      (when marks
	(nnimap-update-info info marks)))))
1110 1111

(defun nnimap-update-info (info marks)
1112 1113 1114 1115 1116 1117 1118 1119
  (destructuring-bind (existing flags high low uidnext start-article
				permanent-flags uidvalidity
				vanished highestmodseq) marks
    (cond
     ;; Ignore groups with no UIDNEXT/marks.  This happens for
     ;; completely empty groups.
     ((and (not existing)
	   (not uidnext))