nnimap.el 57.3 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
	    (cond
	     ((and (or (and (eq nnimap-stream 'network)
385
			    (nnimap-capability "STARTTLS"))
386 387 388 389 390
		       (eq nnimap-stream 'starttls))
		   (fboundp 'open-gnutls-stream))
	      (nnimap-command "STARTTLS")
	      (gnutls-negotiate (nnimap-process nnimap-object) nil))
	     ((and (eq nnimap-stream 'network)
391
		   (nnimap-capability "STARTTLS"))
392 393 394 395 396 397 398 399 400 401
	      (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))
402
		    (return tls-process))))))
403 404 405 406 407 408 409 410 411 412 413 414 415 416
	    (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)
417
		(setq login-result
418 419
		      (if (and (nnimap-capability "AUTH=PLAIN")
			       (nnimap-capability "LOGINDISABLED"))
420 421 422 423 424 425 426 427 428
			  (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))))
429 430 431 432 433 434 435 436 437 438 439 440
		(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
441
	      (when (nnimap-capability "QRESYNC")
442
		(nnimap-command "ENABLE QRESYNC"))
443 444
	      (nnimap-process nnimap-object))))))))

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

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

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

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

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

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

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

518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
(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)
534 535
  (let ((result
	 (nnimap-command
536 537 538 539
	  (or command
	      (if (nnimap-ver4-p)
		  "UID FETCH %d BODY.PEEK[]"
		"UID FETCH %d RFC822.PEEK"))
540 541 542
	  article)))
    ;; Check that we really got an article.
    (goto-char (point-min))
543
    (unless (re-search-forward "\\* [0-9]+ FETCH" nil t)
544 545
      (setq result nil))
    (when result
546 547 548 549
      ;; Remove any data that may have arrived before the FETCH data.
      (beginning-of-line)
      (unless (bobp)
	(delete-region (point-min) (point)))
550 551 552 553 554 555 556
      (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)))

557 558 559
(defun nnimap-capability (capability)
  (member capability (nnimap-capabilities nnimap-object)))

560
(defun nnimap-ver4-p ()
561
  (nnimap-capability "IMAP4REV1"))
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 604 605

(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)
606 607 608 609 610 611
  (let (type boundary)
    (let ((bstruc structure))
      (while (consp (car bstruc))
	(pop bstruc))
      (setq type (car bstruc))
      (setq bstruc (car (cdr bstruc)))
612 613 614
      (let ((has-boundary (member "boundary" bstruc)))
        (when has-boundary
          (setq boundary (cadr has-boundary)))))
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
    (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")))
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650

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

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

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

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

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

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

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

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

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

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

(defun nnimap-process-expiry-targets (articles group server)
  (let ((deleted-articles nil))
    (dolist (article articles)
      (let ((target nnmail-expiry-target))
	(with-temp-buffer
820
          (mm-disable-multibyte)
821
	  (when (nnimap-request-article article group server (current-buffer))
822
	    (nnheader-message 7 "Expiring article %s:%d" group article)
823 824 825 826 827 828 829 830 831 832 833 834 835
	    (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))
836
    (nnimap-delete-article (gnus-compress-sequence deleted-articles))
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
    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))))))))))

855 856

(defun nnimap-find-article-by-message-id (group message-id)
857 858 859 860 861 862 863 864 865 866 867 868 869 870
  (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))))))
871 872 873 874 875

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

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

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

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

952 953 954 955 956 957 958 959 960 961 962
(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))))

963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
(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))))

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

1023 1024 1025 1026 1027 1028 1029 1030
(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.
1031 1032
	(insert (format "%S 0 1 y\n" group))))
    t))
1033

1034
(deffoo nnimap-retrieve-group-data-early (server infos)
1035 1036
  (when (nnimap-possibly-change-group nil server)
    (with-current-buffer (nnimap-buffer)
1037 1038
      (erase-buffer)
      (setf (nnimap-group nnimap-object) nil)
1039
      (let ((qresyncp (nnimap-capability "QRESYNC"))
1040
	    params groups sequences active uidvalidity modseq group)
1041 1042 1043
	;; Go through the infos and gather the data needed to know
	;; what and how to request the data.
	(dolist (info infos)
1044 1045 1046 1047 1048
	  (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)))
1049
	  (if (and qresyncp
1050 1051
		   uidvalidity
		   modseq)
1052
	      (push
1053
	       (list (nnimap-send-command "EXAMINE %S (QRESYNC (%s %s))"
1054 1055
					  (utf7-encode group t)
					  uidvalidity modseq)
1056 1057
		     'qresync
		     nil group 'qresync)
1058 1059
	       sequences)
	    (let ((start
1060
		   (if (and active uidvalidity)
1061
		       ;; Fetch the last 100 flags.
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
		       (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")))
1073 1074
	      (push (list (nnimap-send-command "%s %S" command
					       (utf7-encode group t))
1075
			  (nnimap-send-command "UID FETCH %d:* FLAGS" start)
1076
			  start group command)
1077
		    sequences))))
1078 1079
	sequences))))

1080
(deffoo nnimap-finish-retrieve-group-infos (server infos sequences)
1081 1082 1083 1084
  (when (and sequences
	     (nnimap-possibly-change-group nil server))
    (with-current-buffer (nnimap-buffer)
      ;; Wait for the final data to trickle in.