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