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