99aee4cdd0c615e0f8dd18a6bcd794a6a8a9cf5b
[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                ((or (eq nnimap-stream 'network)
299                     (and (eq nnimap-stream 'starttls)
300                          (fboundp 'open-gnutls-stream)))
301                 (open-network-stream
302                  "*nnimap*" (current-buffer) nnimap-address
303                  (setq port
304                        (or nnimap-server-port
305                            (if (netrc-find-service-number "imap")
306                                "imap"
307                              "143"))))
308                 '("143" "imap"))
309                ((eq nnimap-stream 'shell)
310                 (nnimap-open-shell-stream
311                  "*nnimap*" (current-buffer) nnimap-address
312                  (setq port (or nnimap-server-port "imap")))
313                 '("imap"))
314                ((eq nnimap-stream 'starttls)
315                 (let ((tls-program (nnimap-extend-tls-programs)))
316                   (open-tls-stream
317                    "*nnimap*" (current-buffer) nnimap-address
318                    (setq port (or nnimap-server-port "imap"))
319                    'starttls))
320                 '("imap"))
321                ((memq nnimap-stream '(ssl tls))
322                 (funcall (if (fboundp 'open-gnutls-stream)
323                              'open-gnutls-stream
324                            'open-tls-stream)
325                          "*nnimap*" (current-buffer) nnimap-address
326                          (setq port
327                                (or nnimap-server-port
328                                    (if (netrc-find-service-number "imaps")
329                                        "imaps"
330                                      "993"))))
331                 '("143" "993" "imap" "imaps"))
332                (t
333                 (error "Unknown stream type: %s" nnimap-stream))))
334              connection-result login-result credentials)
335         (setf (nnimap-process nnimap-object)
336               (get-buffer-process (current-buffer)))
337         (if (not (and (nnimap-process nnimap-object)
338                       (memq (process-status (nnimap-process nnimap-object))
339                             '(open run))))
340             (nnheader-report 'nnimap "Unable to contact %s:%s via %s"
341                              nnimap-address port nnimap-stream)
342           (gnus-set-process-query-on-exit-flag
343            (nnimap-process nnimap-object) nil)
344           (if (not (setq connection-result (nnimap-wait-for-connection)))
345               (nnheader-report 'nnimap
346                                "%s" (buffer-substring
347                                      (point) (line-end-position)))
348             ;; Store the greeting (for debugging purposes).
349             (setf (nnimap-greeting nnimap-object)
350                   (buffer-substring (line-beginning-position)
351                                     (line-end-position)))
352             ;; Store the capabilities.
353             (setf (nnimap-capabilities nnimap-object)
354                   (mapcar
355                    #'upcase
356                    (nnimap-find-parameter
357                     "CAPABILITY" (cdr (nnimap-command "CAPABILITY")))))
358             (when nnimap-server-port
359               (push (format "%s" nnimap-server-port) ports))
360             ;; If this is a STARTTLS-capable server, then sever the
361             ;; connection and start a STARTTLS connection instead.
362             (cond
363              ((and (or (and (eq nnimap-stream 'network)
364                             (member "STARTTLS"
365                                     (nnimap-capabilities nnimap-object)))
366                        (eq nnimap-stream 'starttls))
367                    (fboundp 'open-gnutls-stream))
368               (nnimap-command "STARTTLS")
369               (gnutls-negotiate (nnimap-process nnimap-object) nil))
370              ((and (eq nnimap-stream 'network)
371                    (member "STARTTLS" (nnimap-capabilities nnimap-object)))
372               (let ((nnimap-stream 'starttls))
373                 (let ((tls-process
374                        (nnimap-open-connection buffer)))
375                   ;; If the STARTTLS connection was successful, we
376                   ;; kill our first non-encrypted connection.  If it
377                   ;; wasn't successful, we just use our unencrypted
378                   ;; connection.
379                   (when (memq (process-status tls-process) '(open run))
380                     (delete-process (nnimap-process nnimap-object))
381                     (kill-buffer (current-buffer))
382                     (return tls-process))))))
383             (unless (equal connection-result "PREAUTH")
384               (if (not (setq credentials
385                              (if (eq nnimap-authenticator 'anonymous)
386                                  (list "anonymous"
387                                        (message-make-address))
388                                (or
389                                 ;; First look for the credentials based
390                                 ;; on the virtual server name.
391                                 (nnimap-credentials
392                                  (nnoo-current-server 'nnimap) ports t)
393                                 ;; Then look them up based on the
394                                 ;; physical address.
395                                 (nnimap-credentials nnimap-address ports)))))
396                   (setq nnimap-object nil)
397                 (setq login-result (nnimap-command "LOGIN %S %S"
398                                                    (car credentials)
399                                                    (cadr credentials)))
400                 (unless (car login-result)
401                   ;; If the login failed, then forget the credentials
402                   ;; that are now possibly cached.
403                   (dolist (host (list (nnoo-current-server 'nnimap)
404                                       nnimap-address))
405                     (dolist (port ports)
406                       (dolist (element '("login" "password"))
407                         (auth-source-forget-user-or-password
408                          element host port))))
409                   (delete-process (nnimap-process nnimap-object))
410                   (setq nnimap-object nil))))
411             (when nnimap-object
412               (when (member "QRESYNC" (nnimap-capabilities nnimap-object))
413                 (nnimap-command "ENABLE QRESYNC"))
414               (nnimap-process nnimap-object))))))))
415
416 (defun nnimap-extend-tls-programs ()
417   (let ((programs tls-program)
418         result)
419     (unless (consp programs)
420       (setq programs (list programs)))
421     (dolist (program programs)
422       (when (assoc (car (split-string program)) tls-starttls-switches)
423         (push (if (not (string-match "%s" program))
424                   (concat program " " "%s")
425                 program)
426               result)))
427     (nreverse result)))
428
429 (defun nnimap-find-parameter (parameter elems)
430   (let (result)
431     (dolist (elem elems)
432       (cond
433        ((equal (car elem) parameter)
434         (setq result (cdr elem)))
435        ((and (equal (car elem) "OK")
436              (consp (cadr elem))
437              (equal (caadr elem) parameter))
438         (setq result (cdr (cadr elem))))))
439     result))
440
441 (deffoo nnimap-close-server (&optional server)
442   (when (nnoo-change-server 'nnimap server nil)
443     (ignore-errors
444       (delete-process (get-buffer-process (nnimap-buffer))))
445     t))
446
447 (deffoo nnimap-request-close ()
448   t)
449
450 (deffoo nnimap-server-opened (&optional server)
451   (and (nnoo-current-server-p 'nnimap server)
452        nntp-server-buffer
453        (gnus-buffer-live-p nntp-server-buffer)
454        (nnimap-find-connection nntp-server-buffer)))
455
456 (deffoo nnimap-status-message (&optional server)
457   nnimap-status-string)
458
459 (deffoo nnimap-request-article (article &optional group server to-buffer)
460   (with-current-buffer nntp-server-buffer
461     (let ((result (nnimap-possibly-change-group group server))
462           parts structure)
463       (when (stringp article)
464         (setq article (nnimap-find-article-by-message-id group article)))
465       (when (and result
466                  article)
467         (erase-buffer)
468         (with-current-buffer (nnimap-buffer)
469           (erase-buffer)
470           (when nnimap-fetch-partial-articles
471             (nnimap-command "UID FETCH %d (BODYSTRUCTURE)" article)
472             (goto-char (point-min))
473             (when (re-search-forward "FETCH.*BODYSTRUCTURE" nil t)
474               (setq structure (ignore-errors
475                                 (let ((start (point)))
476                                   (forward-sexp 1)
477                                   (downcase-region start (point))
478                                   (goto-char (point))
479                                   (read (current-buffer))))
480                     parts (nnimap-find-wanted-parts structure))))
481           (when (if parts
482                     (nnimap-get-partial-article article parts structure)
483                   (nnimap-get-whole-article article))
484             (let ((buffer (current-buffer)))
485               (with-current-buffer (or to-buffer nntp-server-buffer)
486                 (erase-buffer)
487                 (insert-buffer-substring buffer)
488                 (nnheader-ms-strip-cr)
489                 (cons group article)))))))))
490
491 (defun nnimap-get-whole-article (article)
492   (let ((result
493          (nnimap-command
494           (if (nnimap-ver4-p)
495               "UID FETCH %d BODY.PEEK[]"
496             "UID FETCH %d RFC822.PEEK")
497           article)))
498     ;; Check that we really got an article.
499     (goto-char (point-min))
500     (unless (re-search-forward "\\* [0-9]+ FETCH" nil t)
501       (setq result nil))
502     (when result
503       ;; Remove any data that may have arrived before the FETCH data.
504       (beginning-of-line)
505       (unless (bobp)
506         (delete-region (point-min) (point)))
507       (let ((bytes (nnimap-get-length)))
508         (delete-region (line-beginning-position)
509                        (progn (forward-line 1) (point)))
510         (goto-char (+ (point) bytes))
511         (delete-region (point) (point-max)))
512       t)))
513
514 (defun nnimap-ver4-p ()
515   (member "IMAP4REV1" (nnimap-capabilities nnimap-object)))
516
517 (defun nnimap-get-partial-article (article parts structure)
518   (let ((result
519          (nnimap-command
520           "UID FETCH %d (%s %s)"
521           article
522           (if (nnimap-ver4-p)
523               "BODY.PEEK[HEADER]"
524             "RFC822.HEADER")
525           (if (nnimap-ver4-p)
526               (mapconcat (lambda (part)
527                            (format "BODY.PEEK[%s]" part))
528                          parts " ")
529             (mapconcat (lambda (part)
530                          (format "RFC822.PEEK[%s]" part))
531                        parts " ")))))
532     (when result
533       (nnimap-convert-partial-article structure))))
534
535 (defun nnimap-convert-partial-article (structure)
536   ;; First just skip past the headers.
537   (goto-char (point-min))
538   (let ((bytes (nnimap-get-length))
539         id parts)
540     ;; Delete "FETCH" line.
541     (delete-region (line-beginning-position)
542                    (progn (forward-line 1) (point)))
543     (goto-char (+ (point) bytes))
544     ;; Collect all the body parts.
545     (while (looking-at ".*BODY\\[\\([.0-9]+\\)\\]")
546       (setq id (match-string 1)
547             bytes (nnimap-get-length))
548       (beginning-of-line)
549       (delete-region (point) (progn (forward-line 1) (point)))
550       (push (list id (buffer-substring (point) (+ (point) bytes)))
551             parts)
552       (delete-region (point) (+ (point) bytes)))
553     ;; Delete trailing junk.
554     (delete-region (point) (point-max))
555     ;; Now insert all the parts again where they fit in the structure.
556     (nnimap-insert-partial-structure structure parts)
557     t))
558
559 (defun nnimap-insert-partial-structure (structure parts &optional subp)
560   (let (type boundary)
561     (let ((bstruc structure))
562       (while (consp (car bstruc))
563         (pop bstruc))
564       (setq type (car bstruc))
565       (setq bstruc (car (cdr bstruc)))
566       (when (and (stringp (car bstruc))
567                  (string= (downcase (car bstruc)) "boundary"))
568         (setq boundary (cadr bstruc))))
569     (when subp
570       (insert (format "Content-type: multipart/%s; boundary=%S\n\n"
571                       (downcase type) boundary)))
572     (while (not (stringp (car structure)))
573       (insert "\n--" boundary "\n")
574       (if (consp (caar structure))
575           (nnimap-insert-partial-structure (pop structure) parts t)
576         (let ((bit (pop structure)))
577           (insert (format  "Content-type: %s/%s"
578                            (downcase (nth 0 bit))
579                            (downcase (nth 1 bit))))
580           (if (member "CHARSET" (nth 2 bit))
581               (insert (format
582                        "; charset=%S\n" (cadr (member "CHARSET" (nth 2 bit)))))
583             (insert "\n"))
584           (insert (format "Content-transfer-encoding: %s\n"
585                           (nth 5 bit)))
586           (insert "\n")
587           (when (assoc (nth 9 bit) parts)
588             (insert (cadr (assoc (nth 9 bit) parts)))))))
589     (insert "\n--" boundary "--\n")))
590
591 (defun nnimap-find-wanted-parts (structure)
592   (message-flatten-list (nnimap-find-wanted-parts-1 structure "")))
593
594 (defun nnimap-find-wanted-parts-1 (structure prefix)
595   (let ((num 1)
596         parts)
597     (while (consp (car structure))
598       (let ((sub (pop structure)))
599         (if (consp (car sub))
600             (push (nnimap-find-wanted-parts-1
601                    sub (if (string= prefix "")
602                            (number-to-string num)
603                          (format "%s.%s" prefix num)))
604                   parts)
605           (let ((type (format "%s/%s" (nth 0 sub) (nth 1 sub)))
606                 (id (if (string= prefix "")
607                         (number-to-string num)
608                       (format "%s.%s" prefix num))))
609             (setcar (nthcdr 9 sub) id)
610             (when (if (eq nnimap-fetch-partial-articles t)
611                       (equal id "1")
612                     (string-match nnimap-fetch-partial-articles type))
613               (push id parts))))
614         (incf num)))
615     (nreverse parts)))
616
617 (deffoo nnimap-request-group (group &optional server dont-check info)
618   (let ((result (nnimap-possibly-change-group group server))
619         articles active marks high low)
620     (with-current-buffer nntp-server-buffer
621       (when result
622         (if (and dont-check
623                  (setq active (nth 2 (assoc group nnimap-current-infos))))
624             (insert (format "211 %d %d %d %S\n"
625                             (- (cdr active) (car active))
626                             (car active)
627                             (cdr active)
628                             group))
629           (with-current-buffer (nnimap-buffer)
630             (erase-buffer)
631             (let ((group-sequence
632                    (nnimap-send-command "SELECT %S" (utf7-encode group t)))
633                   (flag-sequence
634                    (nnimap-send-command "UID FETCH 1:* FLAGS")))
635               (nnimap-wait-for-response flag-sequence)
636               (setq marks
637                     (nnimap-flags-to-marks
638                      (nnimap-parse-flags
639                       (list (list group-sequence flag-sequence
640                                   1 group "SELECT")))))
641               (when (and info
642                          marks)
643                 (nnimap-update-infos marks (list info)))
644               (goto-char (point-max))
645               (let ((uidnext (nth 5 (car marks))))
646                 (setq high (or (if uidnext
647                                    (1- uidnext)
648                                  (nth 3 (car marks)))
649                                0)
650                       low (or (nth 4 (car marks)) uidnext 1)))))
651           (erase-buffer)
652           (insert
653            (format
654             "211 %d %d %d %S\n" (1+ (- high low)) low high group)))
655         t))))
656
657 (deffoo nnimap-request-create-group (group &optional server args)
658   (when (nnimap-possibly-change-group nil server)
659     (with-current-buffer (nnimap-buffer)
660       (car (nnimap-command "CREATE %S" (utf7-encode group t))))))
661
662 (deffoo nnimap-request-delete-group (group &optional force server)
663   (when (nnimap-possibly-change-group nil server)
664     (with-current-buffer (nnimap-buffer)
665       (car (nnimap-command "DELETE %S" (utf7-encode group t))))))
666
667 (deffoo nnimap-request-rename-group (group new-name &optional server)
668   (when (nnimap-possibly-change-group nil server)
669     (with-current-buffer (nnimap-buffer)
670       (car (nnimap-command "RENAME %S %S"
671                            (utf7-encode group t) (utf7-encode new-name t))))))
672
673 (deffoo nnimap-request-expunge-group (group &optional server)
674   (when (nnimap-possibly-change-group group server)
675     (with-current-buffer (nnimap-buffer)
676       (car (nnimap-command "EXPUNGE")))))
677
678 (defun nnimap-get-flags (spec)
679   (let ((articles nil)
680         elems end)
681     (with-current-buffer (nnimap-buffer)
682       (erase-buffer)
683       (nnimap-wait-for-response (nnimap-send-command
684                                  "UID FETCH %s FLAGS" spec))
685       (setq end (point))
686       (subst-char-in-region (point-min) (point-max)
687                             ?\\ ?% t)
688       (goto-char (point-min))
689       (while (search-forward " FETCH " end t)
690         (setq elems (read (current-buffer)))
691         (push (cons (cadr (memq 'UID elems))
692                     (cadr (memq 'FLAGS elems)))
693               articles)))
694     (nreverse articles)))
695
696 (deffoo nnimap-close-group (group &optional server)
697   t)
698
699 (deffoo nnimap-request-move-article (article group server accept-form
700                                              &optional last internal-move-group)
701   (with-temp-buffer
702     (when (nnimap-request-article article group server (current-buffer))
703       ;; If the move is internal (on the same server), just do it the easy
704       ;; way.
705       (let ((message-id (message-field-value "message-id")))
706         (if internal-move-group
707             (let ((result
708                    (with-current-buffer (nnimap-buffer)
709                      (nnimap-command "UID COPY %d %S"
710                                      article
711                                      (utf7-encode internal-move-group t)))))
712               (when (car result)
713                 (nnimap-delete-article article)
714                 (cons internal-move-group
715                       (nnimap-find-article-by-message-id
716                        internal-move-group message-id))))
717           ;; Move the article to a different method.
718           (let ((result (eval accept-form)))
719             (when result
720               (nnimap-delete-article article)
721               result)))))))
722
723 (deffoo nnimap-request-expire-articles (articles group &optional server force)
724   (cond
725    ((null articles)
726     nil)
727    ((not (nnimap-possibly-change-group group server))
728     articles)
729    ((and force
730          (eq nnmail-expiry-target 'delete))
731     (unless (nnimap-delete-article (gnus-compress-sequence articles))
732       (message "Article marked for deletion, but not expunged."))
733     nil)
734    (t
735     (let ((deletable-articles
736            (if (or force
737                    (eq nnmail-expiry-wait 'immediate))
738                articles
739              (gnus-sorted-intersection
740               articles
741               (nnimap-find-expired-articles group)))))
742       (if (null deletable-articles)
743           articles
744         (if (eq nnmail-expiry-target 'delete)
745             (nnimap-delete-article (gnus-compress-sequence deletable-articles))
746           (setq deletable-articles
747                 (nnimap-process-expiry-targets
748                  deletable-articles group server)))
749         ;; Return the articles we didn't delete.
750         (gnus-sorted-complement articles deletable-articles))))))
751
752 (defun nnimap-process-expiry-targets (articles group server)
753   (let ((deleted-articles nil))
754     (dolist (article articles)
755       (let ((target nnmail-expiry-target))
756         (with-temp-buffer
757           (when (nnimap-request-article article group server (current-buffer))
758             (message "Expiring article %s:%d" group article)
759             (when (functionp target)
760               (setq target (funcall target group)))
761             (when (and target
762                        (not (eq target 'delete)))
763               (if (or (gnus-request-group target t)
764                       (gnus-request-create-group target))
765                   (nnmail-expiry-target-group target group)
766                 (setq target nil)))
767             (when target
768               (push article deleted-articles))))))
769     ;; Change back to the current group again.
770     (nnimap-possibly-change-group group server)
771     (setq deleted-articles (nreverse deleted-articles))
772     (nnimap-delete-article (gnus-compress-sequence deleted-articles))
773     deleted-articles))
774
775 (defun nnimap-find-expired-articles (group)
776   (let ((cutoff (nnmail-expired-article-p group nil nil)))
777     (with-current-buffer (nnimap-buffer)
778       (let ((result
779              (nnimap-command
780               "UID SEARCH SENTBEFORE %s"
781               (format-time-string
782                (format "%%d-%s-%%Y"
783                        (upcase
784                         (car (rassoc (nth 4 (decode-time cutoff))
785                                      parse-time-months))))
786                cutoff))))
787         (and (car result)
788              (delete 0 (mapcar #'string-to-number
789                                (cdr (assoc "SEARCH" (cdr result))))))))))
790
791
792 (defun nnimap-find-article-by-message-id (group message-id)
793   (with-current-buffer (nnimap-buffer)
794     (erase-buffer)
795     (setf (nnimap-group nnimap-object) nil)
796     (nnimap-send-command "EXAMINE %S" (utf7-encode group t))
797     (let ((sequence
798            (nnimap-send-command "UID SEARCH HEADER Message-Id %S" message-id))
799           article result)
800       (setq result (nnimap-wait-for-response sequence))
801       (when (and result
802                  (car (setq result (nnimap-parse-response))))
803         ;; Select the last instance of the message in the group.
804         (and (setq article
805                    (car (last (assoc "SEARCH" (cdr result)))))
806              (string-to-number article))))))
807
808 (defun nnimap-delete-article (articles)
809   (with-current-buffer (nnimap-buffer)
810     (nnimap-command "UID STORE %s +FLAGS.SILENT (\\Deleted)"
811                     (nnimap-article-ranges articles))
812     (cond
813      ((member "UIDPLUS" (nnimap-capabilities nnimap-object))
814       (nnimap-command "UID EXPUNGE %s"
815                       (nnimap-article-ranges articles))
816       t)
817      (nnimap-expunge
818       (nnimap-command "EXPUNGE")
819       t)
820      (t (gnus-message 7 (concat "nnimap: nnimap-expunge is not set and the "
821                                 "server doesn't support UIDPLUS, so we won't "
822                                 "delete this article now"))))))
823
824 (deffoo nnimap-request-scan (&optional group server)
825   (when (and (nnimap-possibly-change-group nil server)
826              nnimap-inbox
827              nnimap-split-methods)
828     (message "nnimap %s splitting mail..." server)
829     (nnimap-split-incoming-mail)))
830
831 (defun nnimap-marks-to-flags (marks)
832   (let (flags flag)
833     (dolist (mark marks)
834       (when (setq flag (cadr (assq mark nnimap-mark-alist)))
835         (push flag flags)))
836     flags))
837
838 (deffoo nnimap-request-set-mark (group actions &optional server)
839   (when (nnimap-possibly-change-group group server)
840     (let (sequence)
841       (with-current-buffer (nnimap-buffer)
842         (erase-buffer)
843         ;; Just send all the STORE commands without waiting for
844         ;; response.  If they're successful, they're successful.
845         (dolist (action actions)
846           (destructuring-bind (range action marks) action
847             (let ((flags (nnimap-marks-to-flags marks)))
848               (when flags
849                 (setq sequence (nnimap-send-command
850                                 "UID STORE %s %sFLAGS.SILENT (%s)"
851                                 (nnimap-article-ranges range)
852                                 (if (eq action 'del)
853                                     "-"
854                                   "+")
855                                 (mapconcat #'identity flags " ")))))))
856         ;; Wait for the last command to complete to avoid later
857         ;; syncronisation problems with the stream.
858         (when sequence
859           (nnimap-wait-for-response sequence))))))
860
861 (deffoo nnimap-request-accept-article (group &optional server last)
862   (when (nnimap-possibly-change-group nil server)
863     (nnmail-check-syntax)
864     (let ((message-id (message-field-value "message-id"))
865           sequence message)
866       (nnimap-add-cr)
867       (setq message (buffer-string))
868       (with-current-buffer (nnimap-buffer)
869         (setq sequence (nnimap-send-command
870                         "APPEND %S {%d}" (utf7-encode group t)
871                         (length message)))
872         (process-send-string (get-buffer-process (current-buffer)) message)
873         (process-send-string (get-buffer-process (current-buffer))
874                              (if (nnimap-newlinep nnimap-object)
875                                  "\n"
876                                "\r\n"))
877         (let ((result (nnimap-get-response sequence)))
878           (if (not (car result))
879               (progn
880                 (message "%s" (nnheader-get-report-string 'nnimap))
881                 nil)
882             (cons group
883                   (nnimap-find-article-by-message-id group message-id))))))))
884
885 (defun nnimap-add-cr ()
886   (goto-char (point-min))
887   (while (re-search-forward "\r?\n" nil t)
888     (replace-match "\r\n" t t)))
889
890 (defun nnimap-get-groups ()
891   (let ((result (nnimap-command "LIST \"\" \"*\""))
892         groups)
893     (when (car result)
894       (dolist (line (cdr result))
895         (when (and (equal (car line) "LIST")
896                    (not (and (caadr line)
897                              (string-match "noselect" (caadr line)))))
898           (push (car (last line)) groups)))
899       (nreverse groups))))
900
901 (deffoo nnimap-request-list (&optional server)
902   (nnimap-possibly-change-group nil server)
903   (with-current-buffer nntp-server-buffer
904     (erase-buffer)
905     (let ((groups
906            (with-current-buffer (nnimap-buffer)
907              (nnimap-get-groups)))
908           sequences responses)
909       (when groups
910         (with-current-buffer (nnimap-buffer)
911           (setf (nnimap-group nnimap-object) nil)
912           (dolist (group groups)
913             (push (list (nnimap-send-command "EXAMINE %S" (utf7-encode group t))
914                         group)
915                   sequences))
916           (nnimap-wait-for-response (caar sequences))
917           (setq responses
918                 (nnimap-get-responses (mapcar #'car sequences))))
919         (dolist (response responses)
920           (let* ((sequence (car response))
921                  (response (cadr response))
922                  (group (cadr (assoc sequence sequences))))
923             (when (and group
924                        (equal (caar response) "OK"))
925               (let ((uidnext (nnimap-find-parameter "UIDNEXT" response))
926                     highest exists)
927                 (dolist (elem response)
928                   (when (equal (cadr elem) "EXISTS")
929                     (setq exists (string-to-number (car elem)))))
930                 (when uidnext
931                   (setq highest (1- (string-to-number (car uidnext)))))
932                 (cond
933                  ((null highest)
934                   (insert (format "%S 0 1 y\n" (utf7-decode group t))))
935                  ((zerop exists)
936                   ;; Empty group.
937                   (insert (format "%S %d %d y\n"
938                                   (utf7-decode group t) highest (1+ highest))))
939                  (t
940                   ;; Return the widest possible range.
941                   (insert (format "%S %d 1 y\n" (utf7-decode group t)
942                                   (or highest exists)))))))))
943         t))))
944
945 (deffoo nnimap-request-newgroups (date &optional server)
946   (nnimap-possibly-change-group nil server)
947   (with-current-buffer nntp-server-buffer
948     (erase-buffer)
949     (dolist (group (with-current-buffer (nnimap-buffer)
950                      (nnimap-get-groups)))
951       (unless (assoc group nnimap-current-infos)
952         ;; Insert dummy numbers here -- they don't matter.
953         (insert (format "%S 0 1 y\n" group))))
954     t))
955
956 (deffoo nnimap-retrieve-group-data-early (server infos)
957   (when (nnimap-possibly-change-group nil server)
958     (with-current-buffer (nnimap-buffer)
959       (erase-buffer)
960       (setf (nnimap-group nnimap-object) nil)
961       ;; QRESYNC handling isn't implemented.
962       (let ((qresyncp (member "QRESYNC" (nnimap-capabilities nnimap-object)))
963             params groups sequences active uidvalidity modseq group)
964         ;; Go through the infos and gather the data needed to know
965         ;; what and how to request the data.
966         (dolist (info infos)
967           (setq params (gnus-info-params info)
968                 group (gnus-group-real-name (gnus-info-group info))
969                 active (cdr (assq 'active params))
970                 uidvalidity (cdr (assq 'uidvalidity params))
971                 modseq (cdr (assq 'modseq params)))
972           (if (and qresyncp
973                    uidvalidity
974                    modseq)
975               (push
976                (list (nnimap-send-command "EXAMINE %S (QRESYNC (%s %s))"
977                                           group uidvalidity modseq)
978                      'qresync
979                      nil group 'qresync)
980                sequences)
981             (let ((start
982                    (if (and active uidvalidity)
983                        ;; Fetch the last 100 flags.
984                        (max 1 (- (cdr active) 100))
985                      1))
986                   (command
987                    (if uidvalidity
988                        "EXAMINE"
989                      ;; If we don't have a UIDVALIDITY, then this is
990                      ;; the first time we've seen the group, so we
991                      ;; have to do a SELECT (which is slower than an
992                      ;; examine), but will tell us whether the group
993                      ;; is read-only or not.
994                      "SELECT")))
995               (push (list (nnimap-send-command "%s %S" command group)
996                           (nnimap-send-command "UID FETCH %d:* FLAGS" start)
997                           start group command)
998                     sequences)))
999           ;; Some servers apparently can't have many outstanding
1000           ;; commands, so throttle them.
1001           (when (and (not nnimap-streaming)
1002                      (car sequences))
1003             (nnimap-wait-for-response (caar sequences))))
1004         sequences))))
1005
1006 (deffoo nnimap-finish-retrieve-group-infos (server infos sequences)
1007   (when (and sequences
1008              (nnimap-possibly-change-group nil server))
1009     (with-current-buffer (nnimap-buffer)
1010       ;; Wait for the final data to trickle in.
1011       (when (nnimap-wait-for-response (if (eq (cadar sequences) 'qresync)
1012                                           (caar sequences)
1013                                         (cadar sequences))
1014                                       t)
1015         ;; Now we should have most of the data we need, no matter
1016         ;; whether we're QRESYNCING, fetching all the flags from
1017         ;; scratch, or just fetching the last 100 flags per group.
1018         (nnimap-update-infos (nnimap-flags-to-marks
1019                               (nnimap-parse-flags
1020                                (nreverse sequences)))
1021                              infos)
1022         ;; Finally, just return something resembling an active file in
1023         ;; the nntp buffer, so that the agent can save the info, too.
1024         (with-current-buffer nntp-server-buffer
1025           (erase-buffer)
1026           (dolist (info infos)
1027             (let* ((group (gnus-info-group info))
1028                    (active (gnus-active group)))
1029               (when active
1030                 (insert (format "%S %d %d y\n"
1031                                 (gnus-group-real-name group)
1032                                 (cdr active)
1033                                 (car active)))))))))))
1034
1035 (defun nnimap-update-infos (flags infos)
1036   (dolist (info infos)
1037     (let* ((group (gnus-group-real-name (gnus-info-group info)))
1038            (marks (cdr (assoc group flags))))
1039       (when marks
1040         (nnimap-update-info info marks)))))
1041
1042 (defun nnimap-update-info (info marks)
1043   (destructuring-bind (existing flags high low uidnext start-article
1044                                 permanent-flags uidvalidity
1045                                 vanished highestmodseq) marks
1046     (cond
1047      ;; Ignore groups with no UIDNEXT/marks.  This happens for
1048      ;; completely empty groups.
1049      ((and (not existing)
1050            (not uidnext))
1051       (let ((active (cdr (assq 'active (gnus-info-params info)))))
1052         (when active
1053           (gnus-set-active (gnus-info-group info) active))))
1054      ;; We have a mismatch between the old and new UIDVALIDITY
1055      ;; identifiers, so we have to re-request the group info (the next
1056      ;; time).  This virtually never happens.
1057      ((let ((old-uidvalidity
1058              (cdr (assq 'uidvalidity (gnus-info-params info)))))
1059         (and old-uidvalidity
1060              (not (equal old-uidvalidity uidvalidity))
1061              (> start-article 1)))
1062       (gnus-group-remove-parameter info 'uidvalidity)
1063       (gnus-group-remove-parameter info 'modseq))
1064      ;; We have the data needed to update.
1065      (t
1066       (let* ((group (gnus-info-group info))
1067              (completep (and start-article
1068                              (= start-article 1)))
1069              (active (or (cdr (assq 'active (gnus-info-params info)))
1070                          (gnus-active group))))
1071         (when uidnext
1072           (setq high (1- uidnext)))
1073         ;; First set the active ranges based on high/low.
1074         (if (or completep
1075                 (not (gnus-active group)))
1076             (gnus-set-active group
1077                              (cond
1078                               ((and low high)
1079                                (cons low high))
1080                               (uidnext
1081                                ;; No articles in this group.
1082                                (cons uidnext (1- uidnext)))
1083                               (active
1084                                active)
1085                               (start-article
1086                                (cons start-article (1- start-article)))
1087                               (t
1088                                ;; No articles and no uidnext.
1089                                nil)))
1090           (gnus-set-active
1091            group
1092            (cons (car active)
1093                  (or high (1- uidnext)))))
1094         ;; See whether this is a read-only group.
1095         (unless (eq permanent-flags 'not-scanned)
1096           (gnus-group-set-parameter
1097            info 'permanent-flags
1098            (if (memq '%* permanent-flags)
1099                t
1100              nil)))
1101         ;; Update marks and read articles if this isn't a
1102         ;; read-only IMAP group.
1103         (when (cdr (assq 'permanent-flags (gnus-info-params info)))
1104           (if (and highestmodseq
1105                    (not start-article))
1106               ;; We've gotten the data by QRESYNCing.
1107               (nnimap-update-qresync-info
1108                info existing (nnimap-imap-ranges-to-gnus-ranges vanished) flags)
1109             ;; Do normal non-QRESYNC flag updates.
1110             ;; Update the list of read articles.
1111             (let* ((unread
1112                     (gnus-compress-sequence
1113                      (gnus-set-difference
1114                       (gnus-set-difference
1115                        existing
1116                        (cdr (assoc '%Seen flags)))
1117                       (cdr (assoc '%Flagged flags)))))
1118                    (read (gnus-range-difference
1119                           (cons start-article high) unread)))
1120               (when (> start-article 1)
1121                 (setq read
1122                       (gnus-range-nconcat
1123                        (if (> start-article 1)
1124                            (gnus-sorted-range-intersection
1125                             (cons 1 (1- start-article))
1126                             (gnus-info-read info))
1127                          (gnus-info-read info))
1128                        read)))
1129               (gnus-info-set-read info read)
1130               ;; Update the marks.
1131               (setq marks (gnus-info-marks info))
1132               (dolist (type (cdr nnimap-mark-alist))
1133                 (let ((old-marks (assoc (car type) marks))
1134                       (new-marks
1135                        (gnus-compress-sequence
1136                         (cdr (or (assoc (caddr type) flags) ; %Flagged
1137                                  (assoc (intern (cadr type) obarray) flags)
1138                                  (assoc (cadr type) flags)))))) ; "\Flagged"
1139                   (setq marks (delq old-marks marks))
1140                   (pop old-marks)
1141                   (when (and old-marks
1142                              (> start-article 1))
1143                     (setq old-marks (gnus-range-difference
1144                                      old-marks
1145                                      (cons start-article high)))
1146                     (setq new-marks (gnus-range-nconcat old-marks new-marks)))
1147                   (when new-marks
1148                     (push (cons (car type) new-marks) marks)))
1149                 (gnus-info-set-marks info marks t)))))
1150         ;; Note the active level for the next run-through.
1151         (gnus-group-set-parameter info 'active (gnus-active group))
1152         (gnus-group-set-parameter info 'uidvalidity uidvalidity)
1153         (gnus-group-set-parameter info 'modseq highestmodseq)
1154         (nnimap-store-info info (gnus-active group)))))))
1155
1156 (defun nnimap-update-qresync-info (info existing vanished flags)
1157   ;; Add all the vanished articles to the list of read articles.
1158   (gnus-info-set-read
1159    info
1160    (gnus-range-add (gnus-info-read info)
1161                    vanished))
1162   (let ((marks (gnus-info-marks info)))
1163     (dolist (type (cdr nnimap-mark-alist))
1164       (let ((ticks (assoc (car type) marks))
1165             (new-marks
1166              (cdr (or (assoc (caddr type) flags) ; %Flagged
1167                       (assoc (intern (cadr type) obarray) flags)
1168                       (assoc (cadr type) flags))))) ; "\Flagged"
1169         (setq marks (delq ticks marks))
1170         (pop ticks)
1171         ;; Add the new marks we got.
1172         (setq ticks (gnus-add-to-range ticks new-marks))
1173         ;; Remove the marks from messages that don't have them.
1174         (setq ticks (gnus-remove-from-range
1175                      ticks
1176                      (gnus-compress-sequence
1177                       (gnus-sorted-complement existing new-marks))))
1178         (when ticks
1179           (push (cons (car type) ticks) marks)))
1180       (gnus-info-set-marks info marks t))))
1181
1182 (defun nnimap-imap-ranges-to-gnus-ranges (irange)
1183   (if (zerop (length irange))
1184       nil
1185     (let ((result nil))
1186       (dolist (elem (split-string irange ","))
1187         (push
1188          (if (string-match ":" elem)
1189              (let ((numbers (split-string elem ":")))
1190                (cons (string-to-number (car numbers))
1191                      (string-to-number (cadr numbers))))
1192            (string-to-number elem))
1193          result))
1194       (nreverse result))))
1195
1196 (defun nnimap-store-info (info active)
1197   (let* ((group (gnus-group-real-name (gnus-info-group info)))
1198          (entry (assoc group nnimap-current-infos)))
1199     (if entry
1200         (setcdr entry (list info active))
1201       (push (list group info active) nnimap-current-infos))))
1202
1203 (defun nnimap-flags-to-marks (groups)
1204   (let (data group totalp uidnext articles start-article mark permanent-flags
1205              uidvalidity vanished highestmodseq)
1206     (dolist (elem groups)
1207       (setq group (car elem)
1208             uidnext (nth 1 elem)
1209             start-article (nth 2 elem)
1210             permanent-flags (nth 3 elem)
1211             uidvalidity (nth 4 elem)
1212             vanished (nth 5 elem)
1213             highestmodseq (nth 6 elem)
1214             articles (nthcdr 7 elem))
1215       (let ((high (caar articles))
1216             marks low existing)
1217         (dolist (article articles)
1218           (setq low (car article))
1219           (push (car article) existing)
1220           (dolist (flag (cdr article))
1221             (setq mark (assoc flag marks))
1222             (if (not mark)
1223                 (push (list flag (car article)) marks)
1224               (setcdr mark (cons (car article) (cdr mark))))))
1225         (push (list group existing marks high low uidnext start-article
1226                     permanent-flags uidvalidity vanished highestmodseq)
1227               data)))
1228     data))
1229
1230 (defun nnimap-parse-flags (sequences)
1231   (goto-char (point-min))
1232   ;; Change \Delete etc to %Delete, so that the reader can read it.
1233   (subst-char-in-region (point-min) (point-max)
1234                         ?\\ ?% t)
1235   (let (start end articles groups uidnext elems permanent-flags
1236               uidvalidity vanished highestmodseq)
1237     (dolist (elem sequences)
1238       (destructuring-bind (group-sequence flag-sequence totalp group command)
1239           elem
1240         (setq start (point))
1241         (when (and
1242                ;; The EXAMINE was successful.
1243                (search-forward (format "\n%d OK " group-sequence) nil t)
1244                (progn
1245                  (forward-line 1)
1246                  (setq end (point))
1247                  (goto-char start)
1248                  (setq permanent-flags
1249                        (if (equal command "SELECT")
1250                            (and (search-forward "PERMANENTFLAGS "
1251                                                 (or end (point-min)) t)
1252                                 (read (current-buffer)))
1253                          'not-scanned))
1254                  (goto-char start)
1255                  (setq uidnext
1256                        (and (search-forward "UIDNEXT "
1257                                             (or end (point-min)) t)
1258                             (read (current-buffer))))
1259                  (goto-char start)
1260                  (setq uidvalidity
1261                        (and (re-search-forward "UIDVALIDITY \\([0-9]+\\)"
1262                                                (or end (point-min)) t)
1263                             ;; Store UIDVALIDITY as a string, as it's
1264                             ;; too big for 32-bit Emacsen, usually.
1265                             (match-string 1)))
1266                  (goto-char start)
1267                  (setq vanished
1268                        (and (eq flag-sequence 'qresync)
1269                             (re-search-forward "VANISHED.* \\([0-9:,]+\\)"
1270                                                (or end (point-min)) t)
1271                             (match-string 1)))
1272                  (goto-char start)
1273                  (setq highestmodseq
1274                        (and (search-forward "HIGHESTMODSEQ "
1275                                             (or end (point-min)) t)
1276                             (read (current-buffer))))
1277                  (goto-char end)
1278                  (forward-line -1))
1279                ;; The UID FETCH FLAGS was successful.
1280                (or (eq flag-sequence 'qresync)
1281                    (search-forward (format "\n%d OK " flag-sequence) nil t)))
1282           (if (eq flag-sequence 'qresync)
1283               (progn
1284                 (goto-char start)
1285                 (setq start end))
1286             (setq start (point))
1287             (goto-char end))
1288           (while (search-forward " FETCH " start t)
1289             (setq elems (read (current-buffer)))
1290             (push (cons (cadr (memq 'UID elems))
1291                         (cadr (memq 'FLAGS elems)))
1292                   articles))
1293           (push (nconc (list group uidnext totalp permanent-flags uidvalidity
1294                              vanished highestmodseq)
1295                        articles)
1296                 groups)
1297           (goto-char end)
1298           (setq articles nil))))
1299     groups))
1300
1301 (defun nnimap-find-process-buffer (buffer)
1302   (cadr (assoc buffer nnimap-connection-alist)))
1303
1304 (deffoo nnimap-request-post (&optional server)
1305   (setq nnimap-status-string "Read-only server")
1306   nil)
1307
1308 (defun nnimap-possibly-change-group (group server)
1309   (let ((open-result t))
1310     (when (and server
1311                (not (nnimap-server-opened server)))
1312       (setq open-result (nnimap-open-server server)))
1313     (cond
1314      ((not open-result)
1315       nil)
1316      ((not group)
1317       t)
1318      (t
1319       (with-current-buffer (nnimap-buffer)
1320         (if (equal group (nnimap-group nnimap-object))
1321             t
1322           (let ((result (nnimap-command "SELECT %S" (utf7-encode group t))))
1323             (when (car result)
1324               (setf (nnimap-group nnimap-object) group
1325                     (nnimap-select-result nnimap-object) result)
1326               result))))))))
1327
1328 (defun nnimap-find-connection (buffer)
1329   "Find the connection delivering to BUFFER."
1330   (let ((entry (assoc buffer nnimap-connection-alist)))
1331     (when entry
1332       (if (and (buffer-name (cadr entry))
1333                (get-buffer-process (cadr entry))
1334                (memq (process-status (get-buffer-process (cadr entry)))
1335                      '(open run)))
1336           (get-buffer-process (cadr entry))
1337         (setq nnimap-connection-alist (delq entry nnimap-connection-alist))
1338         nil))))
1339
1340 (defvar nnimap-sequence 0)
1341
1342 (defun nnimap-send-command (&rest args)
1343   (process-send-string
1344    (get-buffer-process (current-buffer))
1345    (nnimap-log-command
1346     (format "%d %s%s\n"
1347             (incf nnimap-sequence)
1348             (apply #'format args)
1349             (if (nnimap-newlinep nnimap-object)
1350                 ""
1351               "\r"))))
1352   nnimap-sequence)
1353
1354 (defun nnimap-log-command (command)
1355   (with-current-buffer (get-buffer-create "*imap log*")
1356     (goto-char (point-max))
1357     (insert (format-time-string "%H:%M:%S") " " command))
1358   command)
1359
1360 (defun nnimap-command (&rest args)
1361   (erase-buffer)
1362   (setf (nnimap-last-command-time nnimap-object) (current-time))
1363   (let* ((sequence (apply #'nnimap-send-command args))
1364          (response (nnimap-get-response sequence)))
1365     (if (equal (caar response) "OK")
1366         (cons t response)
1367       (nnheader-report 'nnimap "%s"
1368                        (mapconcat (lambda (a)
1369                                     (format "%s" a))
1370                                   (car response) " "))
1371       nil)))
1372
1373 (defun nnimap-get-response (sequence)
1374   (nnimap-wait-for-response sequence)
1375   (nnimap-parse-response))
1376
1377 (defun nnimap-wait-for-connection ()
1378   (let ((process (get-buffer-process (current-buffer))))
1379     (goto-char (point-min))
1380     (while (and (memq (process-status process)
1381                       '(open run))
1382                 (not (re-search-forward "^[*.] .*\n" nil t)))
1383       (nnheader-accept-process-output process)
1384       (goto-char (point-min)))
1385     (forward-line -1)
1386     (and (looking-at "[*.] \\([A-Z0-9]+\\)")
1387          (match-string 1))))
1388
1389 (defun nnimap-wait-for-response (sequence &optional messagep)
1390   (let ((process (get-buffer-process (current-buffer)))
1391         openp)
1392     (condition-case nil
1393         (progn
1394           (goto-char (point-max))
1395           (while (and (setq openp (memq (process-status process)
1396                                         '(open run)))
1397                       (not (re-search-backward
1398                             (format "^%d .*\n" sequence)
1399                             (if nnimap-streaming
1400                                 (max (point-min) (- (point) 500))
1401                               (point-min))
1402                             t)))
1403             (when messagep
1404               (message "nnimap read %dk" (/ (buffer-size) 1000)))
1405             (nnheader-accept-process-output process)
1406             (goto-char (point-max)))
1407           openp)
1408       (quit
1409        ;; The user hit C-g while we were waiting: kill the process, in case
1410        ;; it's a gnutls-cli process that's stuck (tends to happen a lot behind
1411        ;; NAT routers).
1412        (delete-process process)
1413        nil))))
1414
1415 (defun nnimap-parse-response ()
1416   (let ((lines (split-string (nnimap-last-response-string) "\r\n" t))
1417         result)
1418     (dolist (line lines)
1419       (push (cdr (nnimap-parse-line line)) result))
1420     ;; Return the OK/error code first, and then all the "continuation
1421     ;; lines" afterwards.
1422     (cons (pop result)
1423           (nreverse result))))
1424
1425 ;; Parse an IMAP response line lightly.  They look like
1426 ;; "* OK [UIDVALIDITY 1164213559] UIDs valid", typically, so parse
1427 ;; the lines into a list of strings and lists of string.
1428 (defun nnimap-parse-line (line)
1429   (let (char result)
1430     (with-temp-buffer
1431       (insert line)
1432       (goto-char (point-min))
1433       (while (not (eobp))
1434         (if (eql (setq char (following-char)) ? )
1435             (forward-char 1)
1436           (push
1437            (cond
1438             ((eql char ?\[)
1439              (split-string
1440               (buffer-substring
1441                (1+ (point))
1442                (1- (search-forward "]" (line-end-position) 'move)))))
1443             ((eql char ?\()
1444              (split-string
1445               (buffer-substring
1446                (1+ (point))
1447                (1- (search-forward ")" (line-end-position) 'move)))))
1448             ((eql char ?\")
1449              (forward-char 1)
1450              (buffer-substring
1451               (point)
1452               (1- (or (search-forward "\"" (line-end-position) 'move)
1453                       (point)))))
1454             (t
1455              (buffer-substring (point) (if (search-forward " " nil t)
1456                                            (1- (point))
1457                                          (goto-char (point-max))))))
1458            result)))
1459       (nreverse result))))
1460
1461 (defun nnimap-last-response-string ()
1462   (save-excursion
1463     (forward-line 1)
1464     (let ((end (point)))
1465       (forward-line -1)
1466       (when (not (bobp))
1467         (forward-line -1)
1468         (while (and (not (bobp))
1469                     (eql (following-char) ?*))
1470           (forward-line -1))
1471         (unless (eql (following-char) ?*)
1472           (forward-line 1)))
1473       (buffer-substring (point) end))))
1474
1475 (defun nnimap-get-responses (sequences)
1476   (let (responses)
1477     (dolist (sequence sequences)
1478       (goto-char (point-min))
1479       (when (re-search-forward (format "^%d " sequence) nil t)
1480         (push (list sequence (nnimap-parse-response))
1481               responses)))
1482     responses))
1483
1484 (defvar nnimap-incoming-split-list nil)
1485
1486 (defun nnimap-fetch-inbox (articles)
1487   (erase-buffer)
1488   (nnimap-wait-for-response
1489    (nnimap-send-command
1490     "UID FETCH %s %s"
1491     (nnimap-article-ranges articles)
1492     (format "(UID %s%s)"
1493             (format
1494              (if (nnimap-ver4-p)
1495                  "BODY.PEEK[HEADER] BODY.PEEK"
1496                "RFC822.PEEK"))
1497             (if nnimap-split-download-body-default
1498                 "[]"
1499               "[1]")))
1500    t))
1501
1502 (defun nnimap-split-incoming-mail ()
1503   (with-current-buffer (nnimap-buffer)
1504     (let ((nnimap-incoming-split-list nil)
1505           (nnmail-split-methods (if (eq nnimap-split-methods 'default)
1506                                     nnmail-split-methods
1507                                   nnimap-split-methods))
1508           (nnmail-split-fancy (or nnimap-split-fancy
1509                                   nnmail-split-fancy))
1510           (nnmail-inhibit-default-split-group t)
1511           (groups (nnimap-get-groups))
1512           new-articles)
1513       (erase-buffer)
1514       (nnimap-command "SELECT %S" nnimap-inbox)
1515       (setq new-articles (nnimap-new-articles (nnimap-get-flags "1:*")))
1516       (when new-articles
1517         (nnimap-fetch-inbox new-articles)
1518         (nnimap-transform-split-mail)
1519         (nnheader-ms-strip-cr)
1520         (nnmail-cache-open)
1521         (nnmail-split-incoming (current-buffer)
1522                                #'nnimap-save-mail-spec
1523                                nil nil
1524                                #'nnimap-dummy-active-number
1525                                #'nnimap-save-mail-spec)
1526         (when nnimap-incoming-split-list
1527           (let ((specs (nnimap-make-split-specs nnimap-incoming-split-list))
1528                 sequences junk-articles)
1529             ;; Create any groups that doesn't already exist on the
1530             ;; server first.
1531             (dolist (spec specs)
1532               (when (and (not (member (car spec) groups))
1533                          (not (eq (car spec) 'junk)))
1534                 (nnimap-command "CREATE %S" (utf7-encode (car spec) t))))
1535             ;; Then copy over all the messages.
1536             (erase-buffer)
1537             (dolist (spec specs)
1538               (let ((group (car spec))
1539                     (ranges (cdr spec)))
1540                 (if (eq group 'junk)
1541                     (setq junk-articles ranges)
1542                   (push (list (nnimap-send-command
1543                                "UID COPY %s %S"
1544                                (nnimap-article-ranges ranges)
1545                                (utf7-encode group t))
1546                               ranges)
1547                         sequences))))
1548             ;; Wait for the last COPY response...
1549             (when sequences
1550               (nnimap-wait-for-response (caar sequences))
1551               ;; And then mark the successful copy actions as deleted,
1552               ;; and possibly expunge them.
1553               (nnimap-mark-and-expunge-incoming
1554                (nnimap-parse-copied-articles sequences)))
1555             (nnimap-mark-and-expunge-incoming junk-articles)))))))
1556
1557 (defun nnimap-mark-and-expunge-incoming (range)
1558   (when range
1559     (setq range (nnimap-article-ranges range))
1560     (erase-buffer)
1561     (let ((sequence
1562            (nnimap-send-command
1563             "UID STORE %s +FLAGS.SILENT (\\Deleted)" range)))
1564       (cond
1565        ;; If the server supports it, we now delete the message we have
1566        ;; just copied over.
1567        ((member "UIDPLUS" (nnimap-capabilities nnimap-object))
1568         (setq sequence (nnimap-send-command "UID EXPUNGE %s" range)))
1569        ;; If it doesn't support UID EXPUNGE, then we only expunge if the
1570        ;; user has configured it.
1571        (nnimap-expunge
1572         (setq sequence (nnimap-send-command "EXPUNGE"))))
1573       (nnimap-wait-for-response sequence))))
1574
1575 (defun nnimap-parse-copied-articles (sequences)
1576   (let (sequence copied range)
1577     (goto-char (point-min))
1578     (while (re-search-forward "^\\([0-9]+\\) OK " nil t)
1579       (setq sequence (string-to-number (match-string 1)))
1580       (when (setq range (cadr (assq sequence sequences)))
1581         (push (gnus-uncompress-range range) copied)))
1582     (gnus-compress-sequence (sort (apply #'nconc copied) #'<))))
1583
1584 (defun nnimap-new-articles (flags)
1585   (let (new)
1586     (dolist (elem flags)
1587       (when (or (null (cdr elem))
1588                 (and (not (memq '%Deleted (cdr elem)))
1589                      (not (memq '%Seen (cdr elem)))))
1590         (push (car elem) new)))
1591     (gnus-compress-sequence (nreverse new))))
1592
1593 (defun nnimap-make-split-specs (list)
1594   (let ((specs nil)
1595         entry)
1596     (dolist (elem list)
1597       (destructuring-bind (article spec) elem
1598         (dolist (group (delete nil (mapcar #'car spec)))
1599           (unless (setq entry (assoc group specs))
1600             (push (setq entry (list group)) specs))
1601           (setcdr entry (cons article (cdr entry))))))
1602     (dolist (entry specs)
1603       (setcdr entry (gnus-compress-sequence (sort (cdr entry) #'<))))
1604     specs))
1605
1606 (defun nnimap-transform-split-mail ()
1607   (goto-char (point-min))
1608   (let (article bytes)
1609     (block nil
1610       (while (not (eobp))
1611         (while (not (looking-at "^\\* [0-9]+ FETCH.*UID \\([0-9]+\\)"))
1612           (delete-region (point) (progn (forward-line 1) (point)))
1613           (when (eobp)
1614             (return)))
1615         (setq article (match-string 1)
1616               bytes (nnimap-get-length))
1617         (delete-region (line-beginning-position) (line-end-position))
1618         ;; Insert MMDF separator, and a way to remember what this
1619         ;; article UID is.
1620         (insert (format "\^A\^A\^A\^A\n\nX-nnimap-article: %s" article))
1621         (forward-char (1+ bytes))
1622         (setq bytes (nnimap-get-length))
1623         (delete-region (line-beginning-position) (line-end-position))
1624         (forward-char (1+ bytes))
1625         (delete-region (line-beginning-position) (line-end-position))))))
1626
1627 (defun nnimap-dummy-active-number (group &optional server)
1628   1)
1629
1630 (defun nnimap-save-mail-spec (group-art &optional server full-nov)
1631   (let (article)
1632     (goto-char (point-min))
1633     (if (not (re-search-forward "X-nnimap-article: \\([0-9]+\\)" nil t))
1634         (error "Invalid nnimap mail")
1635       (setq article (string-to-number (match-string 1))))
1636     (push (list article
1637                 (if (eq group-art 'junk)
1638                     (list (cons 'junk 1))
1639                   group-art))
1640           nnimap-incoming-split-list)))
1641
1642 (provide 'nnimap)
1643
1644 ;;; nnimap.el ends here