8dad44d3c7e70dd37a7dd2ae9d30fbadf47673b7
[gnus] / lisp / nnimap.el
1 ;;; nnimap.el --- IMAP interface for Gnus
2
3 ;; Copyright (C) 2010 Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;;         Simon Josefsson <simon@josefsson.org>
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; 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/>.
22
23 ;;; Commentary:
24
25 ;; nnimap interfaces Gnus with IMAP servers.
26
27 ;;; Code:
28
29 (eval-and-compile
30   (require 'nnheader))
31
32 (eval-when-compile
33   (require 'cl))
34
35 (require 'nnheader)
36 (require 'gnus-util)
37 (require 'gnus)
38 (require 'nnoo)
39 (require 'netrc)
40 (require 'utf7)
41 (require 'tls)
42 (require 'parse-time)
43
44 (autoload 'auth-source-forget-user-or-password "auth-source")
45 (autoload 'auth-source-user-or-password "auth-source")
46
47 (nnoo-declare nnimap)
48
49 (defvoo nnimap-address nil
50   "The address of the IMAP server.")
51
52 (defvoo nnimap-server-port nil
53   "The IMAP port used.
54 If nnimap-stream is `ssl', this will default to `imaps'.  If not,
55 it will default to `imap'.")
56
57 (defvoo nnimap-stream 'ssl
58   "How nnimap will talk to the IMAP server.
59 Values are `ssl', `network', `starttls' or `shell'.")
60
61 (defvoo nnimap-shell-program (if (boundp 'imap-shell-program)
62                                  (if (listp imap-shell-program)
63                                      (car imap-shell-program)
64                                    imap-shell-program)
65                                "ssh %s imapd"))
66
67 (defvoo nnimap-inbox nil
68   "The mail box where incoming mail arrives and should be split out of.")
69
70 (defvoo nnimap-split-methods nil
71   "How mail is split.
72 Uses the same syntax as nnmail-split-methods")
73
74 (defvoo nnimap-split-fancy nil
75   "Uses the same syntax as nnmail-split-fancy.")
76
77 (make-obsolete-variable 'nnimap-split-rule "see `nnimap-split-methods'"
78                         "Emacs 24.1")
79
80 (defvoo nnimap-authenticator nil
81   "How nnimap authenticate itself to the server.
82 Possible choices are nil (use default methods) or `anonymous'.")
83
84 (defvoo nnimap-expunge t
85   "If non-nil, expunge articles after deleting them.
86 This is always done if the server supports UID EXPUNGE, but it's
87 not done by default on servers that doesn't support that command.")
88
89 (defvoo nnimap-streaming t
90   "If non-nil, try to use streaming commands with IMAP servers.
91 Switching this off will make nnimap slower, but it helps with
92 some servers.")
93
94 (defvoo nnimap-connection-alist nil)
95
96 (defvoo nnimap-current-infos nil)
97
98 (defvoo nnimap-fetch-partial-articles nil
99   "If non-nil, Gnus will fetch partial articles.
100 If t, nnimap will fetch only the first part.  If a string, it
101 will fetch all parts that have types that match that string.  A
102 likely value would be \"text/\" to automatically fetch all
103 textual parts.")
104
105 (defvar nnimap-process nil)
106
107 (defvar nnimap-status-string "")
108
109 (defvar nnimap-split-download-body-default nil
110   "Internal variable with default value for `nnimap-split-download-body'.")
111
112 (defvar nnimap-keepalive-timer nil)
113 (defvar nnimap-process-buffers nil)
114
115 (defstruct nnimap
116   group process commands capabilities select-result newlinep server
117   last-command-time greeting)
118
119 (defvar nnimap-object nil)
120
121 (defvar nnimap-mark-alist
122   '((read "\\Seen" %Seen)
123     (tick "\\Flagged" %Flagged)
124     (reply "\\Answered" %Answered)
125     (expire "gnus-expire")
126     (dormant "gnus-dormant")
127     (score "gnus-score")
128     (save "gnus-save")
129     (download "gnus-download")
130     (forward "gnus-forward")))
131
132 (defun nnimap-buffer ()
133   (nnimap-find-process-buffer nntp-server-buffer))
134
135 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
136   (with-current-buffer nntp-server-buffer
137     (erase-buffer)
138     (when (nnimap-possibly-change-group group server)
139       (with-current-buffer (nnimap-buffer)
140         (erase-buffer)
141         (nnimap-wait-for-response
142          (nnimap-send-command
143           "UID FETCH %s %s"
144           (nnimap-article-ranges (gnus-compress-sequence articles))
145           (format "(UID RFC822.SIZE BODYSTRUCTURE %s)"
146                   (format
147                    (if (nnimap-ver4-p)
148                        "BODY.PEEK[HEADER.FIELDS %s]"
149                      "RFC822.HEADER.LINES %s")
150                    (append '(Subject From Date Message-Id
151                                      References In-Reply-To Xref)
152                            nnmail-extra-headers))))
153          t)
154         (nnimap-transform-headers))
155       (insert-buffer-substring
156        (nnimap-find-process-buffer (current-buffer))))
157     'headers))
158
159 (defun nnimap-transform-headers ()
160   (goto-char (point-min))
161   (let (article bytes lines size string)
162     (block nil
163       (while (not (eobp))
164         (while (not (looking-at "^\\* [0-9]+ FETCH.*UID \\([0-9]+\\)"))
165           (delete-region (point) (progn (forward-line 1) (point)))
166           (when (eobp)
167             (return)))
168         (setq article (match-string 1))
169         ;; Unfold quoted {number} strings.
170         (while (re-search-forward "[^]] {\\([0-9]+\\)}\r\n"
171                                   (1+ (line-end-position)) t)
172           (setq size (string-to-number (match-string 1)))
173           (delete-region (+ (match-beginning 0) 2) (point))
174           (setq string (delete-region (point) (+ (point) size)))
175           (insert (format "%S" string)))
176         (setq bytes (nnimap-get-length)
177               lines nil)
178         (beginning-of-line)
179         (setq size
180               (and (re-search-forward "RFC822.SIZE \\([0-9]+\\)"
181                                       (line-end-position)
182                                       t)
183                    (match-string 1)))
184         (beginning-of-line)
185         (when (search-forward "BODYSTRUCTURE" (line-end-position) t)
186           (let ((structure (ignore-errors
187                              (read (current-buffer)))))
188             (while (and (consp structure)
189                         (not (stringp (car structure))))
190               (setq structure (car structure)))
191             (setq lines (nth 7 structure))))
192         (delete-region (line-beginning-position) (line-end-position))
193         (insert (format "211 %s Article retrieved." article))
194         (forward-line 1)
195         (when size
196           (insert (format "Chars: %s\n" size)))
197         (when lines
198           (insert (format "Lines: %s\n" lines)))
199         (re-search-forward "^\r$")
200         (delete-region (line-beginning-position) (line-end-position))
201         (insert ".")
202         (forward-line 1)))))
203
204 (defun nnimap-get-length ()
205   (and (re-search-forward "{\\([0-9]+\\)}" (line-end-position) t)
206        (string-to-number (match-string 1))))
207
208 (defun nnimap-article-ranges (ranges)
209   (let (result)
210     (cond
211      ((numberp ranges)
212       (number-to-string ranges))
213      ((numberp (cdr ranges))
214       (format "%d:%d" (car ranges) (cdr ranges)))
215      (t
216       (dolist (elem ranges)
217         (push
218          (if (consp elem)
219              (format "%d:%d" (car elem) (cdr elem))
220            (number-to-string elem))
221          result))
222       (mapconcat #'identity (nreverse result) ",")))))
223
224 (deffoo nnimap-open-server (server &optional defs)
225   (if (nnimap-server-opened server)
226       t
227     (unless (assq 'nnimap-address defs)
228       (setq defs (append defs (list (list 'nnimap-address server)))))
229     (nnoo-change-server 'nnimap server defs)
230     (or (nnimap-find-connection nntp-server-buffer)
231         (nnimap-open-connection nntp-server-buffer))))
232
233 (defun nnimap-make-process-buffer (buffer)
234   (with-current-buffer
235       (generate-new-buffer (format "*nnimap %s %s %s*"
236                                    nnimap-address nnimap-server-port
237                                    (gnus-buffer-exists-p buffer)))
238     (mm-disable-multibyte)
239     (buffer-disable-undo)
240     (gnus-add-buffer)
241     (set (make-local-variable 'after-change-functions) nil)
242     (set (make-local-variable 'nnimap-object)
243          (make-nnimap :server (nnoo-current-server 'nnimap)))
244     (push (list buffer (current-buffer)) nnimap-connection-alist)
245     (push (current-buffer) nnimap-process-buffers)
246     (current-buffer)))
247
248 (defun nnimap-open-shell-stream (name buffer host port)
249   (let ((process-connection-type nil))
250     (start-process name buffer shell-file-name
251                    shell-command-switch
252                    (format-spec
253                     nnimap-shell-program
254                     (format-spec-make
255                      ?s host
256                      ?p port)))))
257
258 (defun nnimap-credentials (address ports &optional inhibit-create)
259   (let (port credentials)
260     ;; Request the credentials from all ports, but only query on the
261     ;; last port if all the previous ones have failed.
262     (while (and (null credentials)
263                 (setq port (pop ports)))
264       (setq credentials
265             (auth-source-user-or-password
266              '("login" "password") address port nil
267              (if inhibit-create
268                  nil
269                (null ports)))))
270     credentials))
271
272 (defun nnimap-keepalive ()
273   (let ((now (current-time)))
274     (dolist (buffer nnimap-process-buffers)
275       (when (buffer-name buffer)
276         (with-current-buffer buffer
277           (when (and nnimap-object
278                      (nnimap-last-command-time nnimap-object)
279                      (> (time-to-seconds
280                          (time-subtract
281                           now
282                           (nnimap-last-command-time nnimap-object)))
283                         ;; More than five minutes since the last command.
284                         (* 5 60)))
285             (nnimap-send-command "NOOP")))))))
286
287 (defun nnimap-open-connection (buffer)
288   (unless nnimap-keepalive-timer
289     (setq nnimap-keepalive-timer (run-at-time (* 60 15) (* 60 15)
290                                               'nnimap-keepalive)))
291   (block nil
292     (with-current-buffer (nnimap-make-process-buffer buffer)
293       (let* ((coding-system-for-read 'binary)
294              (coding-system-for-write 'binary)
295              (port nil)
296              (ports
297               (cond
298                ((eq nnimap-stream 'network)
299                 (open-network-stream
300                  "*nnimap*" (current-buffer) nnimap-address
301                  (setq port
302                        (or nnimap-server-port
303                            (if (netrc-find-service-number "imap")
304                                "imap"
305                              "143"))))
306                 '("143" "imap"))
307                ((eq nnimap-stream 'shell)
308                 (nnimap-open-shell-stream
309                  "*nnimap*" (current-buffer) nnimap-address
310                  (setq port (or nnimap-server-port "imap")))
311                 '("imap"))
312                ((eq nnimap-stream 'starttls)
313                 (let ((tls-program (nnimap-extend-tls-programs)))
314                   (open-tls-stream
315                    "*nnimap*" (current-buffer) nnimap-address
316                    (setq port (or nnimap-server-port "imap"))
317                    'starttls))
318                 '("imap"))
319                ((memq nnimap-stream '(ssl tls))
320                 (funcall (if (fboundp 'open-gnutls-stream)
321                              'open-gnutls-stream
322                            'open-tls-stream)
323                          "*nnimap*" (current-buffer) nnimap-address
324                          (setq port
325                                (or nnimap-server-port
326                                    (if (netrc-find-service-number "imaps")
327                                        "imaps"
328                                      "993"))))
329                 '("143" "993" "imap" "imaps"))
330                (t
331                 (error "Unknown stream type: %s" nnimap-stream))))
332              connection-result login-result credentials)
333         (setf (nnimap-process nnimap-object)
334               (get-buffer-process (current-buffer)))
335         (if (not (and (nnimap-process nnimap-object)
336                       (memq (process-status (nnimap-process nnimap-object))
337                             '(open run))))
338             (nnheader-report 'nnimap "Unable to contact %s:%s via %s"
339                              nnimap-address port nnimap-stream)
340           (gnus-set-process-query-on-exit-flag
341            (nnimap-process nnimap-object) nil)
342           (if (not (setq connection-result (nnimap-wait-for-connection)))
343               (nnheader-report 'nnimap
344                                "%s" (buffer-substring
345                                      (point) (line-end-position)))
346             ;; Store the greeting (for debugging purposes).
347             (setf (nnimap-greeting nnimap-object)
348                   (buffer-substring (line-beginning-position)
349                                     (line-end-position)))
350             ;; Store the capabilities.
351             (setf (nnimap-capabilities nnimap-object)
352                   (mapcar
353                    #'upcase
354                    (nnimap-find-parameter
355                     "CAPABILITY" (cdr (nnimap-command "CAPABILITY")))))
356             (when nnimap-server-port
357               (push (format "%s" nnimap-server-port) ports))
358             ;; If this is a STARTTLS-capable server, then sever the
359             ;; connection and start a STARTTLS connection instead.
360             (when (and (eq nnimap-stream 'network)
361                        (member "STARTTLS" (nnimap-capabilities nnimap-object)))
362               (let ((nnimap-stream 'starttls))
363                 (let ((tls-process
364                        (nnimap-open-connection buffer)))
365                   ;; If the STARTTLS connection was successful, we
366                   ;; kill our first non-encrypted connection.  If it
367                   ;; wasn't successful, we just use our unencrypted
368                   ;; connection.
369                   (when (memq (process-status tls-process) '(open run))
370                     (delete-process (nnimap-process nnimap-object))
371                     (kill-buffer (current-buffer))
372                     (return tls-process)))))
373             (unless (equal connection-result "PREAUTH")
374               (if (not (setq credentials
375                              (if (eq nnimap-authenticator 'anonymous)
376                                  (list "anonymous"
377                                        (message-make-address))
378                                (or
379                                 ;; First look for the credentials based
380                                 ;; on the virtual server name.
381                                 (nnimap-credentials
382                                  (nnoo-current-server 'nnimap) ports t)
383                                 ;; Then look them up based on the
384                                 ;; physical address.
385                                 (nnimap-credentials nnimap-address ports)))))
386                   (setq nnimap-object nil)
387                 (setq login-result (nnimap-command "LOGIN %S %S"
388                                                    (car credentials)
389                                                    (cadr credentials)))
390                 (unless (car login-result)
391                   ;; If the login failed, then forget the credentials
392                   ;; that are now possibly cached.
393                   (dolist (host (list (nnoo-current-server 'nnimap)
394                                       nnimap-address))
395                     (dolist (port ports)
396                       (dolist (element '("login" "password"))
397                         (auth-source-forget-user-or-password
398                          element host port))))
399                   (delete-process (nnimap-process nnimap-object))
400                   (setq nnimap-object nil))))
401             (when nnimap-object
402               (when (member "QRESYNC" (nnimap-capabilities nnimap-object))
403                 (nnimap-command "ENABLE QRESYNC"))
404               (nnimap-process nnimap-object))))))))
405
406 (defun nnimap-extend-tls-programs ()
407   (let ((programs tls-program)
408         result)
409     (unless (consp programs)
410       (setq programs (list programs)))
411     (dolist (program programs)
412       (when (assoc (car (split-string program)) tls-starttls-switches)
413         (push (if (not (string-match "%s" program))
414                   (concat program " " "%s")
415                 program)
416               result)))
417     (nreverse result)))
418
419 (defun nnimap-find-parameter (parameter elems)
420   (let (result)
421     (dolist (elem elems)
422       (cond
423        ((equal (car elem) parameter)
424         (setq result (cdr elem)))
425        ((and (equal (car elem) "OK")
426              (consp (cadr elem))
427              (equal (caadr elem) parameter))
428         (setq result (cdr (cadr elem))))))
429     result))
430
431 (deffoo nnimap-close-server (&optional server)
432   (when (nnoo-change-server 'nnimap server nil)
433     (ignore-errors
434       (delete-process (get-buffer-process (nnimap-buffer))))
435     t))
436
437 (deffoo nnimap-request-close ()
438   t)
439
440 (deffoo nnimap-server-opened (&optional server)
441   (and (nnoo-current-server-p 'nnimap server)
442        nntp-server-buffer
443        (gnus-buffer-live-p nntp-server-buffer)
444        (nnimap-find-connection nntp-server-buffer)))
445
446 (deffoo nnimap-status-message (&optional server)
447   nnimap-status-string)
448
449 (deffoo nnimap-request-article (article &optional group server to-buffer)
450   (with-current-buffer nntp-server-buffer
451     (let ((result (nnimap-possibly-change-group group server))
452           parts structure)
453       (when (stringp article)
454         (setq article (nnimap-find-article-by-message-id group article)))
455       (when (and result
456                  article)
457         (erase-buffer)
458         (with-current-buffer (nnimap-buffer)
459           (erase-buffer)
460           (when nnimap-fetch-partial-articles
461             (nnimap-command "UID FETCH %d (BODYSTRUCTURE)" article)
462             (goto-char (point-min))
463             (when (re-search-forward "FETCH.*BODYSTRUCTURE" nil t)
464               (setq structure (ignore-errors
465                                 (let ((start (point)))
466                                   (forward-sexp 1)
467                                   (downcase-region start (point))
468                                   (goto-char (point))
469                                   (read (current-buffer))))
470                     parts (nnimap-find-wanted-parts structure))))
471           (when (if parts
472                     (nnimap-get-partial-article article parts structure)
473                   (nnimap-get-whole-article article))
474             (let ((buffer (current-buffer)))
475               (with-current-buffer (or to-buffer nntp-server-buffer)
476                 (erase-buffer)
477                 (insert-buffer-substring buffer)
478                 (nnheader-ms-strip-cr)
479                 (cons group article)))))))))
480
481 (defun nnimap-get-whole-article (article)
482   (let ((result
483          (nnimap-command
484           (if (nnimap-ver4-p)
485               "UID FETCH %d BODY.PEEK[]"
486             "UID FETCH %d RFC822.PEEK")
487           article)))
488     ;; Check that we really got an article.
489     (goto-char (point-min))
490     (unless (re-search-forward "\\* [0-9]+ FETCH" nil t)
491       (setq result nil))
492     (when result
493       ;; Remove any data that may have arrived before the FETCH data.
494       (beginning-of-line)
495       (unless (bobp)
496         (delete-region (point-min) (point)))
497       (let ((bytes (nnimap-get-length)))
498         (delete-region (line-beginning-position)
499                        (progn (forward-line 1) (point)))
500         (goto-char (+ (point) bytes))
501         (delete-region (point) (point-max)))
502       t)))
503
504 (defun nnimap-ver4-p ()
505   (member "IMAP4REV1" (nnimap-capabilities nnimap-object)))
506
507 (defun nnimap-get-partial-article (article parts structure)
508   (let ((result
509          (nnimap-command
510           "UID FETCH %d (%s %s)"
511           article
512           (if (nnimap-ver4-p)
513               "BODY.PEEK[HEADER]"
514             "RFC822.HEADER")
515           (if (nnimap-ver4-p)
516               (mapconcat (lambda (part)
517                            (format "BODY.PEEK[%s]" part))
518                          parts " ")
519             (mapconcat (lambda (part)
520                          (format "RFC822.PEEK[%s]" part))
521                        parts " ")))))
522     (when result
523       (nnimap-convert-partial-article structure))))
524
525 (defun nnimap-convert-partial-article (structure)
526   ;; First just skip past the headers.
527   (goto-char (point-min))
528   (let ((bytes (nnimap-get-length))
529         id parts)
530     ;; Delete "FETCH" line.
531     (delete-region (line-beginning-position)
532                    (progn (forward-line 1) (point)))
533     (goto-char (+ (point) bytes))
534     ;; Collect all the body parts.
535     (while (looking-at ".*BODY\\[\\([.0-9]+\\)\\]")
536       (setq id (match-string 1)
537             bytes (nnimap-get-length))
538       (beginning-of-line)
539       (delete-region (point) (progn (forward-line 1) (point)))
540       (push (list id (buffer-substring (point) (+ (point) bytes)))
541             parts)
542       (delete-region (point) (+ (point) bytes)))
543     ;; Delete trailing junk.
544     (delete-region (point) (point-max))
545     ;; Now insert all the parts again where they fit in the structure.
546     (nnimap-insert-partial-structure structure parts)
547     t))
548
549 (defun nnimap-insert-partial-structure (structure parts &optional subp)
550   (let (type boundary)
551     (let ((bstruc structure))
552       (while (consp (car bstruc))
553         (pop bstruc))
554       (setq type (car bstruc))
555       (setq bstruc (car (cdr bstruc)))
556       (when (and (stringp (car bstruc))
557                  (string= (downcase (car bstruc)) "boundary"))
558         (setq boundary (cadr bstruc))))
559     (when subp
560       (insert (format "Content-type: multipart/%s; boundary=%S\n\n"
561                       (downcase type) boundary)))
562     (while (not (stringp (car structure)))
563       (insert "\n--" boundary "\n")
564       (if (consp (caar structure))
565           (nnimap-insert-partial-structure (pop structure) parts t)
566         (let ((bit (pop structure)))
567           (insert (format  "Content-type: %s/%s"
568                            (downcase (nth 0 bit))
569                            (downcase (nth 1 bit))))
570           (if (member "CHARSET" (nth 2 bit))
571               (insert (format
572                        "; charset=%S\n" (cadr (member "CHARSET" (nth 2 bit)))))
573             (insert "\n"))
574           (insert (format "Content-transfer-encoding: %s\n"
575                           (nth 5 bit)))
576           (insert "\n")
577           (when (assoc (nth 9 bit) parts)
578             (insert (cadr (assoc (nth 9 bit) parts)))))))
579     (insert "\n--" boundary "--\n")))
580
581 (defun nnimap-find-wanted-parts (structure)
582   (message-flatten-list (nnimap-find-wanted-parts-1 structure "")))
583
584 (defun nnimap-find-wanted-parts-1 (structure prefix)
585   (let ((num 1)
586         parts)
587     (while (consp (car structure))
588       (let ((sub (pop structure)))
589         (if (consp (car sub))
590             (push (nnimap-find-wanted-parts-1
591                    sub (if (string= prefix "")
592                            (number-to-string num)
593                          (format "%s.%s" prefix num)))
594                   parts)
595           (let ((type (format "%s/%s" (nth 0 sub) (nth 1 sub)))
596                 (id (if (string= prefix "")
597                         (number-to-string num)
598                       (format "%s.%s" prefix num))))
599             (setcar (nthcdr 9 sub) id)
600             (when (if (eq nnimap-fetch-partial-articles t)
601                       (equal id "1")
602                     (string-match nnimap-fetch-partial-articles type))
603               (push id parts))))
604         (incf num)))
605     (nreverse parts)))
606
607 (deffoo nnimap-request-group (group &optional server dont-check info)
608   (let ((result (nnimap-possibly-change-group group server))
609         articles active marks high low)
610     (with-current-buffer nntp-server-buffer
611       (when result
612         (if (and dont-check
613                  (setq active (nth 2 (assoc group nnimap-current-infos))))
614             (insert (format "211 %d %d %d %S\n"
615                             (- (cdr active) (car active))
616                             (car active)
617                             (cdr active)
618                             group))
619           (with-current-buffer (nnimap-buffer)
620             (erase-buffer)
621             (let ((group-sequence
622                    (nnimap-send-command "SELECT %S" (utf7-encode group t)))
623                   (flag-sequence
624                    (nnimap-send-command "UID FETCH 1:* FLAGS")))
625               (nnimap-wait-for-response flag-sequence)
626               (setq marks
627                     (nnimap-flags-to-marks
628                      (nnimap-parse-flags
629                       (list (list group-sequence flag-sequence 1 group)))))
630               (when info
631                 (nnimap-update-infos marks (list info)))
632               (goto-char (point-max))
633               (let ((uidnext (nth 5 (car marks))))
634                 (setq high (or (if uidnext
635                                    (1- uidnext)
636                                  (nth 3 (car marks)))
637                                0)
638                       low (or (nth 4 (car marks)) uidnext 1)))))
639           (erase-buffer)
640           (insert
641            (format
642             "211 %d %d %d %S\n" (1+ (- high low)) low high group)))
643         t))))
644
645 (deffoo nnimap-request-create-group (group &optional server args)
646   (when (nnimap-possibly-change-group nil server)
647     (with-current-buffer (nnimap-buffer)
648       (car (nnimap-command "CREATE %S" (utf7-encode group t))))))
649
650 (deffoo nnimap-request-delete-group (group &optional force server)
651   (when (nnimap-possibly-change-group nil server)
652     (with-current-buffer (nnimap-buffer)
653       (car (nnimap-command "DELETE %S" (utf7-encode group t))))))
654
655 (deffoo nnimap-request-rename-group (group new-name &optional server)
656   (when (nnimap-possibly-change-group nil server)
657     (with-current-buffer (nnimap-buffer)
658       (car (nnimap-command "RENAME %S %S"
659                            (utf7-encode group t) (utf7-encode new-name t))))))
660
661 (deffoo nnimap-request-expunge-group (group &optional server)
662   (when (nnimap-possibly-change-group group server)
663     (with-current-buffer (nnimap-buffer)
664       (car (nnimap-command "EXPUNGE")))))
665
666 (defun nnimap-get-flags (spec)
667   (let ((articles nil)
668         elems)
669     (with-current-buffer (nnimap-buffer)
670       (erase-buffer)
671       (nnimap-wait-for-response (nnimap-send-command
672                                  "UID FETCH %s FLAGS" spec))
673       (goto-char (point-min))
674       (while (re-search-forward "^\\* [0-9]+ FETCH (\\(.*\\))" nil t)
675         (setq elems (nnimap-parse-line (match-string 1)))
676         (push (cons (string-to-number (cadr (member "UID" elems)))
677                     (cadr (member "FLAGS" elems)))
678               articles)))
679     (nreverse articles)))
680
681 (deffoo nnimap-close-group (group &optional server)
682   t)
683
684 (deffoo nnimap-request-move-article (article group server accept-form
685                                              &optional last internal-move-group)
686   (with-temp-buffer
687     (when (nnimap-request-article article group server (current-buffer))
688       ;; If the move is internal (on the same server), just do it the easy
689       ;; way.
690       (let ((message-id (message-field-value "message-id")))
691         (if internal-move-group
692             (let ((result
693                    (with-current-buffer (nnimap-buffer)
694                      (nnimap-command "UID COPY %d %S"
695                                      article
696                                      (utf7-encode internal-move-group t)))))
697               (when (car result)
698                 (nnimap-delete-article article)
699                 (cons internal-move-group
700                       (nnimap-find-article-by-message-id
701                        internal-move-group message-id))))
702           ;; Move the article to a different method.
703           (let ((result (eval accept-form)))
704             (when result
705               (nnimap-delete-article article)
706               result)))))))
707
708 (deffoo nnimap-request-expire-articles (articles group &optional server force)
709   (cond
710    ((null articles)
711     nil)
712    ((not (nnimap-possibly-change-group group server))
713     articles)
714    ((and force
715          (eq nnmail-expiry-target 'delete))
716     (unless (nnimap-delete-article (gnus-compress-sequence articles))
717       (message "Article marked for deletion, but not expunged."))
718     nil)
719    (t
720     (let ((deletable-articles
721            (if (or force
722                    (eq nnmail-expiry-wait 'immediate))
723                articles
724              (gnus-sorted-intersection
725               articles
726               (nnimap-find-expired-articles group)))))
727       (if (null deletable-articles)
728           articles
729         (if (eq nnmail-expiry-target 'delete)
730             (nnimap-delete-article (gnus-compress-sequence deletable-articles))
731           (setq deletable-articles
732                 (nnimap-process-expiry-targets
733                  deletable-articles group server)))
734         ;; Return the articles we didn't delete.
735         (gnus-sorted-complement articles deletable-articles))))))
736
737 (defun nnimap-process-expiry-targets (articles group server)
738   (let ((deleted-articles nil))
739     (dolist (article articles)
740       (let ((target nnmail-expiry-target))
741         (with-temp-buffer
742           (when (nnimap-request-article article group server (current-buffer))
743             (message "Expiring article %s:%d" group article)
744             (when (functionp target)
745               (setq target (funcall target group)))
746             (when (and target
747                        (not (eq target 'delete)))
748               (if (or (gnus-request-group target t)
749                       (gnus-request-create-group target))
750                   (nnmail-expiry-target-group target group)
751                 (setq target nil)))
752             (when target
753               (push article deleted-articles))))))
754     ;; Change back to the current group again.
755     (nnimap-possibly-change-group group server)
756     (setq deleted-articles (nreverse deleted-articles))
757     (nnimap-delete-article (gnus-compress-sequence deleted-articles))
758     deleted-articles))
759
760 (defun nnimap-find-expired-articles (group)
761   (let ((cutoff (nnmail-expired-article-p group nil nil)))
762     (with-current-buffer (nnimap-buffer)
763       (let ((result
764              (nnimap-command
765               "UID SEARCH SENTBEFORE %s"
766               (format-time-string
767                (format "%%d-%s-%%Y"
768                        (upcase
769                         (car (rassoc (nth 4 (decode-time cutoff))
770                                      parse-time-months))))
771                cutoff))))
772         (and (car result)
773              (delete 0 (mapcar #'string-to-number
774                                (cdr (assoc "SEARCH" (cdr result))))))))))
775
776
777 (defun nnimap-find-article-by-message-id (group message-id)
778   (with-current-buffer (nnimap-buffer)
779     (erase-buffer)
780     (setf (nnimap-group nnimap-object) nil)
781     (nnimap-send-command "EXAMINE %S" (utf7-encode group t))
782     (let ((sequence
783            (nnimap-send-command "UID SEARCH HEADER Message-Id %S" message-id))
784           article result)
785       (setq result (nnimap-wait-for-response sequence))
786       (when (and result
787                  (car (setq result (nnimap-parse-response))))
788         ;; Select the last instance of the message in the group.
789         (and (setq article
790                    (car (last (assoc "SEARCH" (cdr result)))))
791              (string-to-number article))))))
792
793 (defun nnimap-delete-article (articles)
794   (with-current-buffer (nnimap-buffer)
795     (nnimap-command "UID STORE %s +FLAGS.SILENT (\\Deleted)"
796                     (nnimap-article-ranges articles))
797     (cond
798      ((member "UIDPLUS" (nnimap-capabilities nnimap-object))
799       (nnimap-command "UID EXPUNGE %s"
800                       (nnimap-article-ranges articles))
801       t)
802      (nnimap-expunge
803       (nnimap-command "EXPUNGE")
804       t)
805      (t (gnus-message 7 (concat "nnimap: nnimap-expunge is not set and the "
806                                 "server doesn't support UIDPLUS, so we won't "
807                                 "delete this article now"))))))
808
809 (deffoo nnimap-request-scan (&optional group server)
810   (when (and (nnimap-possibly-change-group nil server)
811              nnimap-inbox
812              nnimap-split-methods)
813     (message "nnimap %s splitting mail..." server)
814     (nnimap-split-incoming-mail)))
815
816 (defun nnimap-marks-to-flags (marks)
817   (let (flags flag)
818     (dolist (mark marks)
819       (when (setq flag (cadr (assq mark nnimap-mark-alist)))
820         (push flag flags)))
821     flags))
822
823 (deffoo nnimap-request-set-mark (group actions &optional server)
824   (when (nnimap-possibly-change-group group server)
825     (let (sequence)
826       (with-current-buffer (nnimap-buffer)
827         (erase-buffer)
828         ;; Just send all the STORE commands without waiting for
829         ;; response.  If they're successful, they're successful.
830         (dolist (action actions)
831           (destructuring-bind (range action marks) action
832             (let ((flags (nnimap-marks-to-flags marks)))
833               (when flags
834                 (setq sequence (nnimap-send-command
835                                 "UID STORE %s %sFLAGS.SILENT (%s)"
836                                 (nnimap-article-ranges range)
837                                 (if (eq action 'del)
838                                     "-"
839                                   "+")
840                                 (mapconcat #'identity flags " ")))))))
841         ;; Wait for the last command to complete to avoid later
842         ;; syncronisation problems with the stream.
843         (when sequence
844           (nnimap-wait-for-response sequence))))))
845
846 (deffoo nnimap-request-accept-article (group &optional server last)
847   (when (nnimap-possibly-change-group nil server)
848     (nnmail-check-syntax)
849     (let ((message-id (message-field-value "message-id"))
850           sequence message)
851       (nnimap-add-cr)
852       (setq message (buffer-string))
853       (with-current-buffer (nnimap-buffer)
854         (setq sequence (nnimap-send-command
855                         "APPEND %S {%d}" (utf7-encode group t)
856                         (length message)))
857         (process-send-string (get-buffer-process (current-buffer)) message)
858         (process-send-string (get-buffer-process (current-buffer))
859                              (if (nnimap-newlinep nnimap-object)
860                                  "\n"
861                                "\r\n"))
862         (let ((result (nnimap-get-response sequence)))
863           (if (not (car result))
864               (progn
865                 (message "%s" (nnheader-get-report-string 'nnimap))
866                 nil)
867             (cons group
868                   (nnimap-find-article-by-message-id group message-id))))))))
869
870 (defun nnimap-add-cr ()
871   (goto-char (point-min))
872   (while (re-search-forward "\r?\n" nil t)
873     (replace-match "\r\n" t t)))
874
875 (defun nnimap-get-groups ()
876   (let ((result (nnimap-command "LIST \"\" \"*\""))
877         groups)
878     (when (car result)
879       (dolist (line (cdr result))
880         (when (and (equal (car line) "LIST")
881                    (not (and (caadr line)
882                              (string-match "noselect" (caadr line)))))
883           (push (car (last line)) groups)))
884       (nreverse groups))))
885
886 (deffoo nnimap-request-list (&optional server)
887   (nnimap-possibly-change-group nil server)
888   (with-current-buffer nntp-server-buffer
889     (erase-buffer)
890     (let ((groups
891            (with-current-buffer (nnimap-buffer)
892              (nnimap-get-groups)))
893           sequences responses)
894       (when groups
895         (with-current-buffer (nnimap-buffer)
896           (setf (nnimap-group nnimap-object) nil)
897           (dolist (group groups)
898             (push (list (nnimap-send-command "EXAMINE %S" (utf7-encode group t))
899                         group)
900                   sequences))
901           (nnimap-wait-for-response (caar sequences))
902           (setq responses
903                 (nnimap-get-responses (mapcar #'car sequences))))
904         (dolist (response responses)
905           (let* ((sequence (car response))
906                  (response (cadr response))
907                  (group (cadr (assoc sequence sequences))))
908             (when (and group
909                        (equal (caar response) "OK"))
910               (let ((uidnext (nnimap-find-parameter "UIDNEXT" response))
911                     highest exists)
912                 (dolist (elem response)
913                   (when (equal (cadr elem) "EXISTS")
914                     (setq exists (string-to-number (car elem)))))
915                 (when uidnext
916                   (setq highest (1- (string-to-number (car uidnext)))))
917                 (cond
918                  ((null highest)
919                   (insert (format "%S 0 1 y\n" (utf7-decode group t))))
920                  ((zerop exists)
921                   ;; Empty group.
922                   (insert (format "%S %d %d y\n"
923                                   (utf7-decode group t) highest (1+ highest))))
924                  (t
925                   ;; Return the widest possible range.
926                   (insert (format "%S %d 1 y\n" (utf7-decode group t)
927                                   (or highest exists)))))))))
928         t))))
929
930 (deffoo nnimap-request-newgroups (date &optional server)
931   (nnimap-possibly-change-group nil server)
932   (with-current-buffer nntp-server-buffer
933     (erase-buffer)
934     (dolist (group (with-current-buffer (nnimap-buffer)
935                      (nnimap-get-groups)))
936       (unless (assoc group nnimap-current-infos)
937         ;; Insert dummy numbers here -- they don't matter.
938         (insert (format "%S 0 1 y\n" group))))
939     t))
940
941 (deffoo nnimap-retrieve-group-data-early (server infos)
942   (when (nnimap-possibly-change-group nil server)
943     (with-current-buffer (nnimap-buffer)
944       ;; QRESYNC handling isn't implemented.
945       (let ((qresyncp (member "notQRESYNC" (nnimap-capabilities nnimap-object)))
946             marks groups sequences)
947         ;; Go through the infos and gather the data needed to know
948         ;; what and how to request the data.
949         (dolist (info infos)
950           (setq marks (gnus-info-marks info))
951           (push (list (gnus-group-real-name (gnus-info-group info))
952                       (cdr (assq 'active marks))
953                       (cdr (assq 'uid marks)))
954                 groups))
955         ;; Then request the data.
956         (erase-buffer)
957         (setf (nnimap-group nnimap-object) nil)
958         (dolist (elem groups)
959           (if (and qresyncp
960                    (nth 2 elem))
961               (push
962                (list 'qresync
963                      (nnimap-send-command "EXAMINE %S (QRESYNC (%s %s))"
964                                           (car elem)
965                                           (car (nth 2 elem))
966                                           (cdr (nth 2 elem)))
967                      nil
968                      (car elem))
969                sequences)
970             (let ((start
971                    (if (nth 1 elem)
972                        ;; Fetch the last 100 flags.
973                        (max 1 (- (cdr (nth 1 elem)) 100))
974                      1)))
975               (push (list (nnimap-send-command "EXAMINE %S" (car elem))
976                           (nnimap-send-command "UID FETCH %d:* FLAGS" start)
977                           start
978                           (car elem))
979                     sequences)))
980           ;; Some servers apparently can't have many outstanding
981           ;; commands, so throttle them.
982           (when (and (not nnimap-streaming)
983                      (car sequences))
984             (nnimap-wait-for-response (caar sequences))))
985         sequences))))
986
987 (deffoo nnimap-finish-retrieve-group-infos (server infos sequences)
988   (when (and sequences
989              (nnimap-possibly-change-group nil server))
990     (with-current-buffer (nnimap-buffer)
991       ;; Wait for the final data to trickle in.
992       (when (nnimap-wait-for-response (cadar sequences) t)
993         ;; Now we should have all the data we need, no matter whether
994         ;; we're QRESYNCING, fetching all the flags from scratch, or
995         ;; just fetching the last 100 flags per group.
996         (nnimap-update-infos (nnimap-flags-to-marks
997                               (nnimap-parse-flags
998                                (nreverse sequences)))
999                              infos)
1000         ;; Finally, just return something resembling an active file in
1001         ;; the nntp buffer, so that the agent can save the info, too.
1002         (with-current-buffer nntp-server-buffer
1003           (erase-buffer)
1004           (dolist (info infos)
1005             (let* ((group (gnus-info-group info))
1006                    (active (gnus-active group)))
1007               (when active
1008                 (insert (format "%S %d %d y\n"
1009                                 (gnus-group-real-name group)
1010                                 (cdr active)
1011                                 (car active)))))))))))
1012
1013 (defun nnimap-update-infos (flags infos)
1014   (dolist (info infos)
1015     (let ((group (gnus-group-real-name (gnus-info-group info))))
1016       (nnimap-update-info info (cdr (assoc group flags))))))
1017
1018 (defun nnimap-update-info (info marks)
1019   (when (and marks
1020              ;; Ignore groups with no UIDNEXT/marks.  This happens for
1021              ;; completely empty groups.
1022              (or (car marks)
1023                  (nth 4 marks)))
1024     (destructuring-bind (existing flags high low uidnext start-article
1025                                   permanent-flags) marks
1026       (let ((group (gnus-info-group info))
1027             (completep (and start-article
1028                             (= start-article 1))))
1029         (when uidnext
1030           (setq high (1- uidnext)))
1031         ;; First set the active ranges based on high/low.
1032         (if (or completep
1033                 (not (gnus-active group)))
1034             (gnus-set-active group
1035                              (cond
1036                               ((and low high)
1037                                (cons low high))
1038                               (uidnext
1039                                ;; No articles in this group.
1040                                (cons uidnext (1- uidnext)))
1041                               (start-article
1042                                (cons start-article (1- start-article)))
1043                               (t
1044                                ;; No articles and no uidnext.
1045                                nil)))
1046           (gnus-set-active
1047            group
1048            (cons (car (gnus-active group))
1049                  (or high (1- uidnext)))))
1050         ;; Then update the list of read articles.
1051         (let* ((unread
1052                 (gnus-compress-sequence
1053                  (gnus-set-difference
1054                   (gnus-set-difference
1055                    existing
1056                    (cdr (assoc '%Seen flags)))
1057                   (cdr (assoc '%Flagged flags)))))
1058                (read (gnus-range-difference
1059                       (cons start-article high) unread)))
1060           (when (> start-article 1)
1061             (setq read
1062                   (gnus-range-nconcat
1063                    (if (> start-article 1)
1064                        (gnus-sorted-range-intersection
1065                         (cons 1 (1- start-article))
1066                         (gnus-info-read info))
1067                      (gnus-info-read info))
1068                    read)))
1069           (gnus-info-set-read info read)
1070           ;; Update the marks.
1071           (setq marks (gnus-info-marks info))
1072           ;; Note the active level for the next run-through.
1073           (let ((active (assq 'active marks)))
1074             (if active
1075                 (setcdr active (gnus-active group))
1076               (push (cons 'active (gnus-active group)) marks)))
1077           (dolist (type (cdr nnimap-mark-alist))
1078             (let ((old-marks (assoc (car type) marks))
1079                   (new-marks
1080                    (gnus-compress-sequence
1081                     (cdr (or (assoc (caddr type) flags)     ; %Flagged
1082                              (assoc (intern (cadr type) obarray) flags)
1083                              (assoc (cadr type) flags)))))) ; "\Flagged"
1084               (setq marks (delq old-marks marks))
1085               (pop old-marks)
1086               (when (and old-marks
1087                          (> start-article 1))
1088                 (setq old-marks (gnus-range-difference
1089                                  old-marks
1090                                  (cons start-article high)))
1091                 (setq new-marks (gnus-range-nconcat old-marks new-marks)))
1092               (when new-marks
1093                 (push (cons (car type) new-marks) marks)))
1094             (gnus-info-set-marks info marks t)
1095             (nnimap-store-info info (gnus-active group))))))))
1096
1097 (defun nnimap-store-info (info active)
1098   (let* ((group (gnus-group-real-name (gnus-info-group info)))
1099          (entry (assoc group nnimap-current-infos)))
1100     (if entry
1101         (setcdr entry (list info active))
1102       (push (list group info active) nnimap-current-infos))))
1103
1104 (defun nnimap-flags-to-marks (groups)
1105   (let (data group totalp uidnext articles start-article mark permanent-flags)
1106     (dolist (elem groups)
1107       (setq group (car elem)
1108             uidnext (nth 1 elem)
1109             start-article (nth 2 elem)
1110             permanent-flags (nth 3 elem)
1111             articles (nthcdr 4 elem))
1112       (let ((high (caar articles))
1113             marks low existing)
1114         (dolist (article articles)
1115           (setq low (car article))
1116           (push (car article) existing)
1117           (dolist (flag (cdr article))
1118             (setq mark (assoc flag marks))
1119             (if (not mark)
1120                 (push (list flag (car article)) marks)
1121               (setcdr mark (cons (car article) (cdr mark))))))
1122         (push (list group existing marks high low uidnext start-article
1123                     permanent-flags)
1124               data)))
1125     data))
1126
1127 (defun nnimap-parse-flags (sequences)
1128   (goto-char (point-min))
1129   ;; Change \Delete etc to %Delete, so that the reader can read it.
1130   (subst-char-in-region (point-min) (point-max)
1131                         ?\\ ?% t)
1132   (let (start end articles groups uidnext elems permanent-flags)
1133     (dolist (elem sequences)
1134       (destructuring-bind (group-sequence flag-sequence totalp group) elem
1135         (setq start (point))
1136         ;; The EXAMINE was successful.
1137         (when (and (search-forward (format "\n%d OK " group-sequence) nil t)
1138                    (progn
1139                      (forward-line 1)
1140                      (setq end (point))
1141                      (goto-char start)
1142                      (setq permanent-flags
1143                            (and (search-forward "PERMANENTFLAGS "
1144                                                  (or end (point-min)) t)
1145                                 (read (current-buffer))))
1146                      (goto-char start)
1147                      (setq uidnext
1148                            (and (search-forward "UIDNEXT "
1149                                                  (or end (point-min)) t)
1150                                 (read (current-buffer))))
1151                      (goto-char end)
1152                      (forward-line -1))
1153                    ;; The UID FETCH FLAGS was successful.
1154                    (search-forward (format "\n%d OK " flag-sequence) nil t))
1155           (setq start (point))
1156           (goto-char end)
1157           (while (search-forward " FETCH " start t)
1158             (setq elems (read (current-buffer)))
1159             (push (cons (cadr (memq 'UID elems))
1160                         (cadr (memq 'FLAGS elems)))
1161                   articles))
1162           (push (nconc (list group uidnext totalp permanent-flags) articles)
1163                 groups)
1164           (setq articles nil))))
1165     groups))
1166
1167 (defun nnimap-find-process-buffer (buffer)
1168   (cadr (assoc buffer nnimap-connection-alist)))
1169
1170 (deffoo nnimap-request-post (&optional server)
1171   (setq nnimap-status-string "Read-only server")
1172   nil)
1173
1174 (defun nnimap-possibly-change-group (group server)
1175   (let ((open-result t))
1176     (when (and server
1177                (not (nnimap-server-opened server)))
1178       (setq open-result (nnimap-open-server server)))
1179     (cond
1180      ((not open-result)
1181       nil)
1182      ((not group)
1183       t)
1184      (t
1185       (with-current-buffer (nnimap-buffer)
1186         (if (equal group (nnimap-group nnimap-object))
1187             t
1188           (let ((result (nnimap-command "SELECT %S" (utf7-encode group t))))
1189             (when (car result)
1190               (setf (nnimap-group nnimap-object) group
1191                     (nnimap-select-result nnimap-object) result)
1192               result))))))))
1193
1194 (defun nnimap-find-connection (buffer)
1195   "Find the connection delivering to BUFFER."
1196   (let ((entry (assoc buffer nnimap-connection-alist)))
1197     (when entry
1198       (if (and (buffer-name (cadr entry))
1199                (get-buffer-process (cadr entry))
1200                (memq (process-status (get-buffer-process (cadr entry)))
1201                      '(open run)))
1202           (get-buffer-process (cadr entry))
1203         (setq nnimap-connection-alist (delq entry nnimap-connection-alist))
1204         nil))))
1205
1206 (defvar nnimap-sequence 0)
1207
1208 (defun nnimap-send-command (&rest args)
1209   (process-send-string
1210    (get-buffer-process (current-buffer))
1211    (nnimap-log-command
1212     (format "%d %s%s\n"
1213             (incf nnimap-sequence)
1214             (apply #'format args)
1215             (if (nnimap-newlinep nnimap-object)
1216                 ""
1217               "\r"))))
1218   nnimap-sequence)
1219
1220 (defun nnimap-log-command (command)
1221   (with-current-buffer (get-buffer-create "*imap log*")
1222     (goto-char (point-max))
1223     (insert (format-time-string "%H:%M:%S") " " command))
1224   command)
1225
1226 (defun nnimap-command (&rest args)
1227   (erase-buffer)
1228   (setf (nnimap-last-command-time nnimap-object) (current-time))
1229   (let* ((sequence (apply #'nnimap-send-command args))
1230          (response (nnimap-get-response sequence)))
1231     (if (equal (caar response) "OK")
1232         (cons t response)
1233       (nnheader-report 'nnimap "%s"
1234                        (mapconcat (lambda (a)
1235                                     (format "%s" a))
1236                                   (car response) " "))
1237       nil)))
1238
1239 (defun nnimap-get-response (sequence)
1240   (nnimap-wait-for-response sequence)
1241   (nnimap-parse-response))
1242
1243 (defun nnimap-wait-for-connection ()
1244   (let ((process (get-buffer-process (current-buffer))))
1245     (goto-char (point-min))
1246     (while (and (memq (process-status process)
1247                       '(open run))
1248                 (not (re-search-forward "^[*.] .*\n" nil t)))
1249       (nnheader-accept-process-output process)
1250       (goto-char (point-min)))
1251     (forward-line -1)
1252     (and (looking-at "[*.] \\([A-Z0-9]+\\)")
1253          (match-string 1))))
1254
1255 (defun nnimap-wait-for-response (sequence &optional messagep)
1256   (let ((process (get-buffer-process (current-buffer)))
1257         openp)
1258     (goto-char (point-max))
1259     (while (and (setq openp (memq (process-status process)
1260                                   '(open run)))
1261                 (not (re-search-backward
1262                       (format "^%d .*\n" sequence)
1263                       (if nnimap-streaming
1264                           (max (point-min) (- (point) 500))
1265                         (point-min))
1266                       t)))
1267       (when messagep
1268         (message "nnimap read %dk" (/ (buffer-size) 1000)))
1269       (nnheader-accept-process-output process)
1270       (goto-char (point-max)))
1271     openp))
1272
1273 (defun nnimap-parse-response ()
1274   (let ((lines (split-string (nnimap-last-response-string) "\r\n" t))
1275         result)
1276     (dolist (line lines)
1277       (push (cdr (nnimap-parse-line line)) result))
1278     ;; Return the OK/error code first, and then all the "continuation
1279     ;; lines" afterwards.
1280     (cons (pop result)
1281           (nreverse result))))
1282
1283 ;; Parse an IMAP response line lightly.  They look like
1284 ;; "* OK [UIDVALIDITY 1164213559] UIDs valid", typically, so parse
1285 ;; the lines into a list of strings and lists of string.
1286 (defun nnimap-parse-line (line)
1287   (let (char result)
1288     (with-temp-buffer
1289       (insert line)
1290       (goto-char (point-min))
1291       (while (not (eobp))
1292         (if (eql (setq char (following-char)) ? )
1293             (forward-char 1)
1294           (push
1295            (cond
1296             ((eql char ?\[)
1297              (split-string
1298               (buffer-substring
1299                (1+ (point))
1300                (1- (search-forward "]" (line-end-position) 'move)))))
1301             ((eql char ?\()
1302              (split-string
1303               (buffer-substring
1304                (1+ (point))
1305                (1- (search-forward ")" (line-end-position) 'move)))))
1306             ((eql char ?\")
1307              (forward-char 1)
1308              (buffer-substring
1309               (point)
1310               (1- (or (search-forward "\"" (line-end-position) 'move)
1311                       (point)))))
1312             (t
1313              (buffer-substring (point) (if (search-forward " " nil t)
1314                                            (1- (point))
1315                                          (goto-char (point-max))))))
1316            result)))
1317       (nreverse result))))
1318
1319 (defun nnimap-last-response-string ()
1320   (save-excursion
1321     (forward-line 1)
1322     (let ((end (point)))
1323       (forward-line -1)
1324       (when (not (bobp))
1325         (forward-line -1)
1326         (while (and (not (bobp))
1327                     (eql (following-char) ?*))
1328           (forward-line -1))
1329         (unless (eql (following-char) ?*)
1330           (forward-line 1)))
1331       (buffer-substring (point) end))))
1332
1333 (defun nnimap-get-responses (sequences)
1334   (let (responses)
1335     (dolist (sequence sequences)
1336       (goto-char (point-min))
1337       (when (re-search-forward (format "^%d " sequence) nil t)
1338         (push (list sequence (nnimap-parse-response))
1339               responses)))
1340     responses))
1341
1342 (defvar nnimap-incoming-split-list nil)
1343
1344 (defun nnimap-fetch-inbox (articles)
1345   (erase-buffer)
1346   (nnimap-wait-for-response
1347    (nnimap-send-command
1348     "UID FETCH %s %s"
1349     (nnimap-article-ranges articles)
1350     (format "(UID %s%s)"
1351             (format
1352              (if (nnimap-ver4-p)
1353                  "BODY.PEEK[HEADER] BODY.PEEK"
1354                "RFC822.PEEK"))
1355             (if nnimap-split-download-body-default
1356                 "[]"
1357               "[1]")))
1358    t))
1359
1360 (defun nnimap-split-incoming-mail ()
1361   (with-current-buffer (nnimap-buffer)
1362     (let ((nnimap-incoming-split-list nil)
1363           (nnmail-split-methods (if (eq nnimap-split-methods 'default)
1364                                     nnmail-split-methods
1365                                   nnimap-split-methods))
1366           (nnmail-split-fancy (or nnimap-split-fancy
1367                                   nnmail-split-fancy))
1368           (nnmail-inhibit-default-split-group t)
1369           (groups (nnimap-get-groups))
1370           new-articles)
1371       (erase-buffer)
1372       (nnimap-command "SELECT %S" nnimap-inbox)
1373       (setq new-articles (nnimap-new-articles (nnimap-get-flags "1:*")))
1374       (when new-articles
1375         (nnimap-fetch-inbox new-articles)
1376         (nnimap-transform-split-mail)
1377         (nnheader-ms-strip-cr)
1378         (nnmail-cache-open)
1379         (nnmail-split-incoming (current-buffer)
1380                                #'nnimap-save-mail-spec
1381                                nil nil
1382                                #'nnimap-dummy-active-number
1383                                #'nnimap-save-mail-spec)
1384         (when nnimap-incoming-split-list
1385           (let ((specs (nnimap-make-split-specs nnimap-incoming-split-list))
1386                 sequences junk-articles)
1387             ;; Create any groups that doesn't already exist on the
1388             ;; server first.
1389             (dolist (spec specs)
1390               (when (and (not (member (car spec) groups))
1391                          (not (eq (car spec) 'junk)))
1392                 (nnimap-command "CREATE %S" (utf7-encode (car spec) t))))
1393             ;; Then copy over all the messages.
1394             (erase-buffer)
1395             (dolist (spec specs)
1396               (let ((group (car spec))
1397                     (ranges (cdr spec)))
1398                 (if (eq group 'junk)
1399                     (setq junk-articles ranges)
1400                   (push (list (nnimap-send-command
1401                                "UID COPY %s %S"
1402                                (nnimap-article-ranges ranges)
1403                                (utf7-encode group t))
1404                               ranges)
1405                         sequences))))
1406             ;; Wait for the last COPY response...
1407             (when sequences
1408               (nnimap-wait-for-response (caar sequences))
1409               ;; And then mark the successful copy actions as deleted,
1410               ;; and possibly expunge them.
1411               (nnimap-mark-and-expunge-incoming
1412                (nnimap-parse-copied-articles sequences)))
1413             (nnimap-mark-and-expunge-incoming junk-articles)))))))
1414
1415 (defun nnimap-mark-and-expunge-incoming (range)
1416   (when range
1417     (setq range (nnimap-article-ranges range))
1418     (erase-buffer)
1419     (let ((sequence
1420            (nnimap-send-command
1421             "UID STORE %s +FLAGS.SILENT (\\Deleted)" range)))
1422       (cond
1423        ;; If the server supports it, we now delete the message we have
1424        ;; just copied over.
1425        ((member "UIDPLUS" (nnimap-capabilities nnimap-object))
1426         (setq sequence (nnimap-send-command "UID EXPUNGE %s" range)))
1427        ;; If it doesn't support UID EXPUNGE, then we only expunge if the
1428        ;; user has configured it.
1429        (nnimap-expunge
1430         (setq sequence (nnimap-send-command "EXPUNGE"))))
1431       (nnimap-wait-for-response sequence))))
1432
1433 (defun nnimap-parse-copied-articles (sequences)
1434   (let (sequence copied range)
1435     (goto-char (point-min))
1436     (while (re-search-forward "^\\([0-9]+\\) OK " nil t)
1437       (setq sequence (string-to-number (match-string 1)))
1438       (when (setq range (cadr (assq sequence sequences)))
1439         (push (gnus-uncompress-range range) copied)))
1440     (gnus-compress-sequence (sort (apply #'nconc copied) #'<))))
1441
1442 (defun nnimap-new-articles (flags)
1443   (let (new)
1444     (dolist (elem flags)
1445       (when (or (null (cdr elem))
1446                 (and (not (memq '%Deleted (cdr elem)))
1447                      (not (memq '%Seen (cdr elem)))))
1448         (push (car elem) new)))
1449     (gnus-compress-sequence (nreverse new))))
1450
1451 (defun nnimap-make-split-specs (list)
1452   (let ((specs nil)
1453         entry)
1454     (dolist (elem list)
1455       (destructuring-bind (article spec) elem
1456         (dolist (group (delete nil (mapcar #'car spec)))
1457           (unless (setq entry (assoc group specs))
1458             (push (setq entry (list group)) specs))
1459           (setcdr entry (cons article (cdr entry))))))
1460     (dolist (entry specs)
1461       (setcdr entry (gnus-compress-sequence (sort (cdr entry) #'<))))
1462     specs))
1463
1464 (defun nnimap-transform-split-mail ()
1465   (goto-char (point-min))
1466   (let (article bytes)
1467     (block nil
1468       (while (not (eobp))
1469         (while (not (looking-at "^\\* [0-9]+ FETCH.*UID \\([0-9]+\\)"))
1470           (delete-region (point) (progn (forward-line 1) (point)))
1471           (when (eobp)
1472             (return)))
1473         (setq article (match-string 1)
1474               bytes (nnimap-get-length))
1475         (delete-region (line-beginning-position) (line-end-position))
1476         ;; Insert MMDF separator, and a way to remember what this
1477         ;; article UID is.
1478         (insert (format "\^A\^A\^A\^A\n\nX-nnimap-article: %s" article))
1479         (forward-char (1+ bytes))
1480         (setq bytes (nnimap-get-length))
1481         (delete-region (line-beginning-position) (line-end-position))
1482         (forward-char (1+ bytes))
1483         (delete-region (line-beginning-position) (line-end-position))))))
1484
1485 (defun nnimap-dummy-active-number (group &optional server)
1486   1)
1487
1488 (defun nnimap-save-mail-spec (group-art &optional server full-nov)
1489   (let (article)
1490     (goto-char (point-min))
1491     (if (not (re-search-forward "X-nnimap-article: \\([0-9]+\\)" nil t))
1492         (error "Invalid nnimap mail")
1493       (setq article (string-to-number (match-string 1))))
1494     (push (list article
1495                 (if (eq group-art 'junk)
1496                     (list (cons 'junk 1))
1497                   group-art))
1498           nnimap-incoming-split-list)))
1499
1500 (provide 'nnimap)
1501
1502 ;;; nnimap.el ends here