cgit.sxemacs.org Git - gnus/blob - lisp/nnimap.el

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