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