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
  41 (nnoo-declare nnimap)
  42
  43 (defvoo nnimap-address nil
  44   "The address of the IMAP server.")
  45
  46 (defvoo nnimap-server-port nil
  47   "The IMAP port used.
  48 If nnimap-stream is `ssl', this will default to `imaps'.  If not,
  49 it will default to `imap'.")
  50
  51 (defvoo nnimap-stream 'ssl
  52   "How nnimap will talk to the IMAP server.
  53 Values are `ssl' and `network'.")
  54
  55 (defvoo nnimap-shell-program (if (boundp 'imap-shell-program)
  56                                  (if (listp imap-shell-program)
  57                                      (car imap-shell-program)
  58                                    imap-shell-program)
  59                                "ssh %s imapd"))
  60
  61 (defvoo nnimap-inbox nil
  62   "The mail box where incoming mail arrives and should be split out of.")
  63
  64 (defvoo nnimap-expunge-inbox nil
  65   "If non-nil, expunge the inbox after fetching mail.
  66 This is always done if the server supports UID EXPUNGE, but it's
  67 not done by default on servers that doesn't support that command.")
  68
  69 (defvoo nnimap-authenticator nil
  70   "How nnimap authenticate itself to the server.
  71 Possible choices are nil (use default methods) or `anonymous'.")
  72
  73 (defvoo nnimap-fetch-partial-articles nil
  74   "If non-nil, nnimap will fetch partial articles.
  75 If t, nnimap will fetch only the first part.  If a string, it
  76 will fetch all parts that have types that match that string.  A
  77 likely value would be \"text/\" to automatically fetch all
  78 textual parts.")
  79
  80 (defvoo nnimap-expunge nil)
  81
  82 (defvoo nnimap-connection-alist nil)
  83
  84 (defvoo nnimap-current-infos nil)
  85
  86 (defvar nnimap-process nil)
  87
  88 (defvar nnimap-status-string "")
  89
  90 (defvar nnimap-split-download-body-default nil
  91   "Internal variable with default value for `nnimap-split-download-body'.")
  92
  93 (defstruct nnimap
  94   group process commands capabilities select-result newlinep)
  95
  96 (defvar nnimap-object nil)
  97
  98 (defvar nnimap-mark-alist
  99   '((read "\\Seen")
 100     (tick "\\Flagged")
 101     (reply "\\Answered")
 102     (expire "gnus-expire")
 103     (dormant "gnus-dormant")
 104     (score "gnus-score")
 105     (save "gnus-save")
 106     (download "gnus-download")
 107     (forward "gnus-forward")))
 108
 109 (defvar nnimap-split-methods nil)
 110
 111 (defun nnimap-buffer ()
 112   (nnimap-find-process-buffer nntp-server-buffer))
 113
 114 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
 115   (with-current-buffer nntp-server-buffer
 116     (erase-buffer)
 117     (when (nnimap-possibly-change-group group server)
 118       (with-current-buffer (nnimap-buffer)
 119         (nnimap-send-command "SELECT %S" (utf7-encode group t))
 120         (erase-buffer)
 121         (nnimap-wait-for-response
 122          (nnimap-send-command
 123           "UID FETCH %s %s"
 124           (nnimap-article-ranges (gnus-compress-sequence articles))
 125           (format "(UID RFC822.SIZE BODYSTRUCTURE %s)"
 126                   (format
 127                    (if (member "IMAP4REV1"
 128                                (nnimap-capabilities nnimap-object))
 129                        "BODY.PEEK[HEADER.FIELDS %s]"
 130                      "RFC822.HEADER.LINES %s")
 131                    (append '(Subject From Date Message-Id
 132                                      References In-Reply-To Xref)
 133                            nnmail-extra-headers))))
 134          t)
 135         (nnimap-transform-headers))
 136       (insert-buffer-substring
 137        (nnimap-find-process-buffer (current-buffer))))
 138     t))
 139
 140 (defun nnimap-transform-headers ()
 141   (goto-char (point-min))
 142   (let (article bytes lines size)
 143     (block nil
 144       (while (not (eobp))
 145         (while (not (looking-at "^\\* [0-9]+ FETCH.*UID \\([0-9]+\\)"))
 146           (delete-region (point) (progn (forward-line 1) (point)))
 147           (when (eobp)
 148             (return)))
 149         (setq article (match-string 1)
 150               bytes (nnimap-get-length)
 151               lines nil)
 152         (beginning-of-line)
 153         (setq size
 154               (and (re-search-forward "RFC822.SIZE \\([0-9]+\\)"
 155                                       (line-end-position)
 156                                       t)
 157                    (match-string 1)))
 158         (beginning-of-line)
 159         (when (search-forward "BODYSTRUCTURE" (line-end-position) t)
 160           (let ((structure (ignore-errors (read (current-buffer)))))
 161             (while (and (consp structure)
 162                         (not (stringp (car structure))))
 163               (setq structure (car structure)))
 164             (setq lines (nth 7 structure))))
 165         (delete-region (line-beginning-position) (line-end-position))
 166         (insert (format "211 %s Article retrieved." article))
 167         (forward-line 1)
 168         (when size
 169           (insert (format "Chars: %s\n" size)))
 170         (when lines
 171           (insert (format "Lines: %s\n" lines)))
 172         (re-search-forward "^\r$")
 173         (delete-region (line-beginning-position) (line-end-position))
 174         (insert ".")
 175         (forward-line 1)))))
 176
 177 (defun nnimap-get-length ()
 178   (and (re-search-forward "{\\([0-9]+\\)}" (line-end-position) t)
 179        (string-to-number (match-string 1))))
 180
 181 (defun nnimap-article-ranges (ranges)
 182   (let (result)
 183     (cond
 184      ((numberp ranges)
 185       (number-to-string ranges))
 186      ((numberp (cdr ranges))
 187       (format "%d:%d" (car ranges) (cdr ranges)))
 188      (t
 189       (dolist (elem ranges)
 190         (push
 191          (if (consp elem)
 192              (format "%d:%d" (car elem) (cdr elem))
 193            (number-to-string elem))
 194          result))
 195       (mapconcat #'identity (nreverse result) ",")))))
 196
 197 (deffoo nnimap-open-server (server &optional defs)
 198   (if (nnimap-server-opened server)
 199       t
 200     (unless (assq 'nnimap-address defs)
 201       (setq defs (append defs (list (list 'nnimap-address server)))))
 202     (nnoo-change-server 'nnimap server defs)
 203     (or (nnimap-find-connection nntp-server-buffer)
 204         (nnimap-open-connection nntp-server-buffer))))
 205
 206 (defun nnimap-make-process-buffer (buffer)
 207   (with-current-buffer
 208       (generate-new-buffer (format "*nnimap %s %s %s*"
 209                                    nnimap-address nnimap-server-port
 210                                    (gnus-buffer-exists-p buffer)))
 211     (mm-disable-multibyte)
 212     (buffer-disable-undo)
 213     (gnus-add-buffer)
 214     (set (make-local-variable 'after-change-functions) nil)
 215     (set (make-local-variable 'nnimap-object) (make-nnimap))
 216     (push (list buffer (current-buffer)) nnimap-connection-alist)
 217     (current-buffer)))
 218
 219 (defun nnimap-open-shell-stream (name buffer host port)
 220   (let ((process-connection-type nil))
 221     (start-process name buffer shell-file-name
 222                    shell-command-switch
 223                    (format-spec
 224                     nnimap-shell-program
 225                     (format-spec-make
 226                      ?s host
 227                      ?p port)))))
 228
 229 (defun nnimap-credentials (address ports)
 230   (let (port credentials)
 231     ;; Request the credentials from all ports, but only query on the
 232     ;; last port if all the previous ones have failed.
 233     (while (and (null credentials)
 234                 (setq port (pop ports)))
 235       (setq credentials
 236             (auth-source-user-or-password
 237              '("login" "password") address port nil (null ports))))
 238     credentials))
 239
 240 (defun nnimap-open-connection (buffer)
 241   (with-current-buffer (nnimap-make-process-buffer buffer)
 242     (let* ((coding-system-for-read 'binary)
 243            (coding-system-for-write 'binary)
 244            (ports
 245             (cond
 246              ((eq nnimap-stream 'network)
 247               (open-network-stream
 248                "*nnimap*" (current-buffer) nnimap-address
 249                (or nnimap-server-port
 250                    (if (netrc-find-service-number "imap")
 251                        "imap"
 252                      "143")))
 253               '("143" "imap"))
 254              ((eq nnimap-stream 'shell)
 255               (nnimap-open-shell-stream
 256                "*nnimap*" (current-buffer) nnimap-address
 257                (or nnimap-server-port "imap"))
 258               '("imap"))
 259              ((eq nnimap-stream 'ssl)
 260               (open-tls-stream
 261                "*nnimap*" (current-buffer) nnimap-address
 262                (or nnimap-server-port
 263                    (if (netrc-find-service-number "imaps")
 264                        "imaps"
 265                      "993")))
 266               '("143" "993" "imap" "imaps"))))
 267            connection-result login-result credentials)
 268       (setf (nnimap-process nnimap-object)
 269             (get-buffer-process (current-buffer)))
 270       (when (and (nnimap-process nnimap-object)
 271                  (memq (process-status (nnimap-process nnimap-object))
 272                        '(open run)))
 273         (gnus-set-process-query-on-exit-flag (nnimap-process nnimap-object) nil)
 274         (when (setq connection-result (nnimap-wait-for-connection))
 275           (unless (equal connection-result "PREAUTH")
 276             (if (not (setq credentials
 277                            (if (eq nnimap-authenticator 'anonymous)
 278                                (list "anonymous"
 279                                      (message-make-address))
 280                              (nnimap-credentials
 281                               nnimap-address
 282                               (if nnimap-server-port
 283                                   (cons (format "%s" nnimap-server-port) ports)
 284                                 ports)))))
 285                 (setq nnimap-object nil)
 286               (setq login-result (nnimap-command "LOGIN %S %S"
 287                                                  (car credentials)
 288                                                  (cadr credentials)))
 289               (unless (car login-result)
 290                 (delete-process (nnimap-process nnimap-object))
 291                 (setq nnimap-object nil))))
 292           (when nnimap-object
 293             (setf (nnimap-capabilities nnimap-object)
 294                   (mapcar
 295                    #'upcase
 296                    (or (nnimap-find-parameter "CAPABILITY" (cdr login-result))
 297                        (nnimap-find-parameter
 298                         "CAPABILITY" (cdr (nnimap-command "CAPABILITY"))))))
 299             (when (member "QRESYNC" (nnimap-capabilities nnimap-object))
 300               (nnimap-command "ENABLE QRESYNC"))
 301             t))))))
 302
 303 (defun nnimap-find-parameter (parameter elems)
 304   (let (result)
 305     (dolist (elem elems)
 306       (cond
 307        ((equal (car elem) parameter)
 308         (setq result (cdr elem)))
 309        ((and (equal (car elem) "OK")
 310              (consp (cadr elem))
 311              (equal (caadr elem) parameter))
 312         (setq result (cdr (cadr elem))))))
 313     result))
 314
 315 (deffoo nnimap-close-server (&optional server)
 316   t)
 317
 318 (deffoo nnimap-request-close ()
 319   t)
 320
 321 (deffoo nnimap-server-opened (&optional server)
 322   (and (nnoo-current-server-p 'nnimap server)
 323        nntp-server-buffer
 324        (gnus-buffer-live-p nntp-server-buffer)
 325        (nnimap-find-connection nntp-server-buffer)))
 326
 327 (deffoo nnimap-status-message (&optional server)
 328   nnimap-status-string)
 329
 330 (deffoo nnimap-request-article (article &optional group server to-buffer)
 331   (with-current-buffer nntp-server-buffer
 332     (let ((result (nnimap-possibly-change-group group server))
 333           parts)
 334       (when (stringp article)
 335         (setq article (nnimap-find-article-by-message-id group article)))
 336       (when (and result
 337                  article)
 338         (erase-buffer)
 339         (with-current-buffer (nnimap-buffer)
 340           (erase-buffer)
 341           (when nnimap-fetch-partial-articles
 342             (if (eq nnimap-fetch-partial-articles t)
 343                 (setq parts '(1))
 344               (nnimap-command "UID FETCH %d (BODYSTRUCTURE)" article)
 345               (goto-char (point-min))
 346               (when (re-search-forward "FETCH.*BODYSTRUCTURE" nil t)
 347                 (let ((structure (ignore-errors (read (current-buffer)))))
 348                   (setq parts (nnimap-find-wanted-parts structure))))))
 349           (setq result
 350                 (nnimap-command
 351                  (if (member "IMAP4REV1" (nnimap-capabilities nnimap-object))
 352                      "UID FETCH %d BODY.PEEK[]"
 353                    "UID FETCH %d RFC822.PEEK")
 354                  article))
 355           ;; Check that we really got an article.
 356           (goto-char (point-min))
 357           (unless (looking-at "\\* [0-9]+ FETCH")
 358             (setq result nil)))
 359         (let ((buffer (nnimap-find-process-buffer (current-buffer))))
 360           (when (car result)
 361             (with-current-buffer (or to-buffer nntp-server-buffer)
 362               (insert-buffer-substring buffer)
 363               (goto-char (point-min))
 364               (let ((bytes (nnimap-get-length)))
 365                 (delete-region (line-beginning-position)
 366                                (progn (forward-line 1) (point)))
 367                 (goto-char (+ (point) bytes))
 368                 (delete-region (point) (point-max))
 369                 (nnheader-ms-strip-cr))
 370               (cons group article))))))))
 371
 372 (defun nnimap-find-wanted-parts (structure)
 373   (message-flatten-list (nnimap-find-wanted-parts-1 structure "")))
 374
 375 (defun nnimap-find-wanted-parts-1 (structure prefix)
 376   (let ((num 1)
 377         parts)
 378     (while (consp (car structure))
 379       (let ((sub (pop structure)))
 380         (if (consp (car sub))
 381             (push (nnimap-find-wanted-parts-1
 382                    sub (if (string= prefix "")
 383                            (number-to-string num)
 384                          (format "%s.%s" prefix num)))
 385                   parts)
 386           (let ((type (format "%s/%s" (nth 0 sub) (nth 1 sub))))
 387             (when (string-match nnimap-fetch-partial-articles type)
 388               (push (if (string= prefix "")
 389                         (number-to-string num)
 390                       (format "%s.%s" prefix num))
 391                     parts)))
 392           (incf num))))
 393     (nreverse parts)))
 394
 395 (deffoo nnimap-request-group (group &optional server dont-check info)
 396   (let ((result (nnimap-possibly-change-group group server))
 397         articles active marks high low)
 398     (with-current-buffer nntp-server-buffer
 399       (when result
 400         (if (and dont-check
 401                  (setq active (nth 2 (assoc group nnimap-current-infos))))
 402             (insert (format "211 %d %d %d %S\n"
 403                             (- (cdr active) (car active))
 404                             (car active)
 405                             (cdr active)
 406                             group))
 407           (with-current-buffer (nnimap-buffer)
 408             (erase-buffer)
 409             (let ((group-sequence
 410                    (nnimap-send-command "SELECT %S" (utf7-encode group t)))
 411                   (flag-sequence
 412                    (nnimap-send-command "UID FETCH 1:* FLAGS")))
 413               (nnimap-wait-for-response flag-sequence)
 414               (setq marks
 415                     (nnimap-flags-to-marks
 416                      (nnimap-parse-flags
 417                       (list (list group-sequence flag-sequence 1 group)))))
 418               (when info
 419                 (nnimap-update-infos marks (list info)))
 420               (goto-char (point-max))
 421               (cond
 422                (marks
 423                 (setq high (nth 3 (car marks))
 424                       low (nth 4 (car marks))))
 425                ((re-search-backward "UIDNEXT \\([0-9]+\\)" nil t)
 426                 (setq high (1- (string-to-number (match-string 1)))
 427                       low 1)))))
 428           (erase-buffer)
 429           (insert
 430            (format
 431             "211 %d %d %d %S\n" (1+ (- high low)) low high group)))
 432         t))))
 433
 434 (deffoo nnimap-request-create-group (group &optional server args)
 435   (when (nnimap-possibly-change-group nil server)
 436     (with-current-buffer (nnimap-buffer)
 437       (car (nnimap-command "CREATE %S" (utf7-encode group t))))))
 438
 439 (deffoo nnimap-request-delete-group (group &optional force server)
 440   (when (nnimap-possibly-change-group nil server)
 441     (with-current-buffer (nnimap-buffer)
 442       (car (nnimap-command "DELETE %S" (utf7-encode group t))))))
 443
 444 (deffoo nnimap-request-expunge-group (group &optional server)
 445   (when (nnimap-possibly-change-group group server)
 446     (with-current-buffer (nnimap-buffer)
 447       (car (nnimap-command "EXPUNGE")))))
 448
 449 (defun nnimap-get-flags (spec)
 450   (let ((articles nil)
 451         elems)
 452     (with-current-buffer (nnimap-buffer)
 453       (erase-buffer)
 454       (nnimap-wait-for-response (nnimap-send-command
 455                                  "UID FETCH %s FLAGS" spec))
 456       (goto-char (point-min))
 457       (while (re-search-forward "^\\* [0-9]+ FETCH (\\(.*\\))" nil t)
 458         (setq elems (nnimap-parse-line (match-string 1)))
 459         (push (cons (string-to-number (cadr (member "UID" elems)))
 460                     (cadr (member "FLAGS" elems)))
 461               articles)))
 462     (nreverse articles)))
 463
 464 (deffoo nnimap-close-group (group &optional server)
 465   t)
 466
 467 (deffoo nnimap-request-move-article (article group server accept-form
 468                                              &optional last internal-move-group)
 469   (with-temp-buffer
 470     (when (nnimap-request-article article group server (current-buffer))
 471       ;; If the move is internal (on the same server), just do it the easy
 472       ;; way.
 473       (let ((message-id (message-field-value "message-id")))
 474         (if internal-move-group
 475             (let ((result
 476                    (with-current-buffer (nnimap-buffer)
 477                      (nnimap-command "UID COPY %d %S"
 478                                      article
 479                                      (utf7-encode internal-move-group t)))))
 480               (when (car result)
 481                 (nnimap-delete-article article)
 482                 (cons internal-move-group
 483                       (nnimap-find-article-by-message-id
 484                        internal-move-group message-id))))
 485           ;; Move the article to a different method.
 486           (let ((result (eval accept-form)))
 487             (when result
 488               (nnimap-delete-article article)
 489               result)))))))
 490
 491 (deffoo nnimap-request-expire-articles (articles group &optional server force)
 492   (cond
 493    ((null articles)
 494     nil)
 495    ((not (nnimap-possibly-change-group group server))
 496     articles)
 497    ((and force
 498          (eq nnmail-expiry-target 'delete))
 499     (unless (nnimap-delete-article articles)
 500       (message "Article marked for deletion, but not expunged."))
 501     nil)
 502    (t
 503     (let ((deletable-articles
 504            (if force
 505                articles
 506              (gnus-sorted-intersection
 507               articles
 508               (nnimap-find-expired-articles group)))))
 509       (if (null deletable-articles)
 510           articles
 511         (if (eq nnmail-expiry-target 'delete)
 512             (nnimap-delete-article deletable-articles)
 513           (setq deletable-articles
 514                 (nnimap-process-expiry-targets
 515                  deletable-articles group server)))
 516         ;; Return the articles we didn't delete.
 517         (gnus-sorted-complement articles deletable-articles))))))
 518
 519 (defun nnimap-process-expiry-targets (articles group server)
 520   (let ((deleted-articles nil))
 521     (dolist (article articles)
 522       (let ((target nnmail-expiry-target))
 523         (with-temp-buffer
 524           (when (nnimap-request-article article group server (current-buffer))
 525             (message "Expiring article %s:%d" group article)
 526             (when (functionp target)
 527               (setq target (funcall target group)))
 528             (when (and target
 529                        (not (eq target 'delete)))
 530               (if (or (gnus-request-group target t)
 531                       (gnus-request-create-group target))
 532                   (nnmail-expiry-target-group target group)
 533                 (setq target nil)))
 534             (when target
 535               (push article deleted-articles))))))
 536     ;; Change back to the current group again.
 537     (nnimap-possibly-change-group group server)
 538     (setq deleted-articles (nreverse deleted-articles))
 539     (nnimap-delete-article deleted-articles)
 540     deleted-articles))
 541
 542 (defun nnimap-find-expired-articles (group)
 543   (let ((cutoff (nnmail-expired-article-p group nil nil)))
 544     (with-current-buffer (nnimap-buffer)
 545       (let ((result
 546              (nnimap-command
 547               "UID SEARCH SENTBEFORE %s"
 548               (format-time-string
 549                (format "%%d-%s-%%Y"
 550                        (upcase
 551                         (car (rassoc (nth 4 (decode-time cutoff))
 552                                      parse-time-months))))
 553                cutoff))))
 554         (and (car result)
 555              (delete 0 (mapcar #'string-to-number
 556                                (cdr (assoc "SEARCH" (cdr result))))))))))
 557
 558
 559 (defun nnimap-find-article-by-message-id (group message-id)
 560   (when (nnimap-possibly-change-group group nil)
 561     (with-current-buffer (nnimap-buffer)
 562       (let ((result
 563              (nnimap-command "UID SEARCH HEADER Message-Id %S" message-id))
 564             article)
 565         (when (car result)
 566           ;; Select the last instance of the message in the group.
 567           (and (setq article
 568                      (car (last (assoc "SEARCH" (cdr result)))))
 569                (string-to-number article)))))))
 570
 571 (defun nnimap-delete-article (articles)
 572   (with-current-buffer (nnimap-buffer)
 573     (nnimap-command "UID STORE %s +FLAGS.SILENT (\\Deleted)"
 574                     (nnimap-article-ranges articles))
 575     (cond
 576      ((member "UIDPLUS" (nnimap-capabilities nnimap-object))
 577       (nnimap-command "UID EXPUNGE %s"
 578                       (nnimap-article-ranges articles))
 579       t)
 580      (nnimap-expunge
 581       (nnimap-command "EXPUNGE")
 582       t))))
 583
 584 (deffoo nnimap-request-scan (&optional group server)
 585   (when (and (nnimap-possibly-change-group nil server)
 586              (equal group nnimap-inbox)
 587              nnimap-inbox
 588              nnimap-split-methods)
 589     (nnimap-split-incoming-mail)))
 590
 591 (defun nnimap-marks-to-flags (marks)
 592   (let (flags flag)
 593     (dolist (mark marks)
 594       (when (setq flag (cadr (assq mark nnimap-mark-alist)))
 595         (push flag flags)))
 596     flags))
 597
 598 (deffoo nnimap-request-set-mark (group actions &optional server)
 599   (when (nnimap-possibly-change-group group server)
 600     (let (sequence)
 601       (with-current-buffer (nnimap-buffer)
 602         ;; Just send all the STORE commands without waiting for
 603         ;; response.  If they're successful, they're successful.
 604         (dolist (action actions)
 605           (destructuring-bind (range action marks) action
 606             (let ((flags (nnimap-marks-to-flags marks)))
 607               (when flags
 608                 (setq sequence (nnimap-send-command
 609                                 "UID STORE %s %sFLAGS.SILENT (%s)"
 610                                 (nnimap-article-ranges range)
 611                                 (if (eq action 'del)
 612                                     "-"
 613                                   "+")
 614                                 (mapconcat #'identity flags " ")))))))
 615         ;; Wait for the last command to complete to avoid later
 616         ;; syncronisation problems with the stream.
 617         (when sequence
 618           (nnimap-wait-for-response sequence))))))
 619
 620 (deffoo nnimap-request-accept-article (group &optional server last)
 621   (when (nnimap-possibly-change-group nil server)
 622     (nnmail-check-syntax)
 623     (let ((message (buffer-string))
 624           (message-id (message-field-value "message-id"))
 625           sequence)
 626       (with-current-buffer (nnimap-buffer)
 627         (setq sequence (nnimap-send-command
 628                         "APPEND %S {%d}" (utf7-encode group t)
 629                         (length message)))
 630         (process-send-string (get-buffer-process (current-buffer)) message)
 631         (process-send-string (get-buffer-process (current-buffer))
 632                              (if (nnimap-newlinep nnimap-object)
 633                                  "\n"
 634                                "\r\n"))
 635         (let ((result (nnimap-get-response sequence)))
 636           (when result
 637             (cons group
 638                   (nnimap-find-article-by-message-id group message-id))))))))
 639
 640 (defun nnimap-add-cr ()
 641   (goto-char (point-min))
 642   (while (re-search-forward "\r?\n" nil t)
 643     (replace-match "\r\n" t t)))
 644
 645 (defun nnimap-get-groups ()
 646   (let ((result (nnimap-command "LIST \"\" \"*\""))
 647         groups)
 648     (when (car result)
 649       (dolist (line (cdr result))
 650         (when (and (equal (car line) "LIST")
 651                    (not (and (caadr line)
 652                              (string-match "noselect" (caadr line)))))
 653           (push (car (last line)) groups)))
 654       (nreverse groups))))
 655
 656 (deffoo nnimap-request-list (&optional server)
 657   (nnimap-possibly-change-group nil server)
 658   (with-current-buffer nntp-server-buffer
 659     (erase-buffer)
 660     (let ((groups
 661            (with-current-buffer (nnimap-buffer)
 662              (nnimap-get-groups)))
 663           sequences responses)
 664       (when groups
 665         (with-current-buffer (nnimap-buffer)
 666           (dolist (group groups)
 667             (push (list (nnimap-send-command "EXAMINE %S" (utf7-encode group t))
 668                         group)
 669                   sequences))
 670           (nnimap-wait-for-response (caar sequences))
 671           (setq responses
 672                 (nnimap-get-responses (mapcar #'car sequences))))
 673         (dolist (response responses)
 674           (let* ((sequence (car response))
 675                  (response (cadr response))
 676                  (group (cadr (assoc sequence sequences))))
 677             (when (and group
 678                        (equal (caar response) "OK"))
 679               (let ((uidnext (nnimap-find-parameter "UIDNEXT" response))
 680                     highest exists)
 681                 (dolist (elem response)
 682                   (when (equal (cadr elem) "EXISTS")
 683                     (setq exists (string-to-number (car elem)))))
 684                 (when uidnext
 685                   (setq highest (1- (string-to-number (car uidnext)))))
 686                 (cond
 687                  ((null highest)
 688                   (insert (format "%S 0 1 y\n" (utf7-decode group t))))
 689                  ((zerop exists)
 690                   ;; Empty group.
 691                   (insert (format "%S %d %d y\n"
 692                                   (utf7-decode group t) highest (1+ highest))))
 693                  (t
 694                   ;; Return the widest possible range.
 695                   (insert (format "%S %d 1 y\n" (utf7-decode group t)
 696                                   (or highest exists)))))))))
 697         t))))
 698
 699 (deffoo nnimap-retrieve-group-data-early (server infos)
 700   (when (nnimap-possibly-change-group nil server)
 701     (with-current-buffer (nnimap-buffer)
 702       ;; QRESYNC handling isn't implemented.
 703       (let ((qresyncp (member "notQRESYNC" (nnimap-capabilities nnimap-object)))
 704             marks groups sequences)
 705         ;; Go through the infos and gather the data needed to know
 706         ;; what and how to request the data.
 707         (dolist (info infos)
 708           (setq marks (gnus-info-marks info))
 709           (push (list (gnus-group-real-name (gnus-info-group info))
 710                       (cdr (assq 'active marks))
 711                       (cdr (assq 'uid marks)))
 712                 groups))
 713         ;; Then request the data.
 714         (erase-buffer)
 715         (dolist (elem groups)
 716           (if (and qresyncp
 717                    (nth 2 elem))
 718               (push
 719                (list 'qresync
 720                      (nnimap-send-command "EXAMINE %S (QRESYNC (%s %s))"
 721                                           (car elem)
 722                                           (car (nth 2 elem))
 723                                           (cdr (nth 2 elem)))
 724                      nil
 725                      (car elem))
 726                sequences)
 727             (let ((start
 728                    (if (nth 1 elem)
 729                        ;; Fetch the last 100 flags.
 730                        (max 1 (- (cdr (nth 1 elem)) 100))
 731                      1)))
 732               (push (list (nnimap-send-command "EXAMINE %S" (car elem))
 733                           (nnimap-send-command "UID FETCH %d:* FLAGS" start)
 734                           start
 735                           (car elem))
 736                     sequences))))
 737         sequences))))
 738
 739 (deffoo nnimap-finish-retrieve-group-infos (server infos sequences)
 740   (when (and sequences
 741              (nnimap-possibly-change-group nil server))
 742     (with-current-buffer (nnimap-buffer)
 743       ;; Wait for the final data to trickle in.
 744       (nnimap-wait-for-response (cadar sequences))
 745       ;; Now we should have all the data we need, no matter whether
 746       ;; we're QRESYNCING, fetching all the flags from scratch, or
 747       ;; just fetching the last 100 flags per group.
 748       (nnimap-update-infos (nnimap-flags-to-marks
 749                             (nnimap-parse-flags
 750                              (nreverse sequences)))
 751                            infos)
 752       ;; Finally, just return something resembling an active file in
 753       ;; the nntp buffer, so that the agent can save the info, too.
 754       (with-current-buffer nntp-server-buffer
 755         (erase-buffer)
 756         (dolist (info infos)
 757           (let* ((group (gnus-info-group info))
 758                  (active (gnus-active group)))
 759             (when active
 760               (insert (format "%S %d %d y\n"
 761                               (gnus-group-real-name group)
 762                               (cdr active)
 763                               (car active))))))))))
 764
 765 (defun nnimap-update-infos (flags infos)
 766   (dolist (info infos)
 767     (let ((group (gnus-group-real-name (gnus-info-group info))))
 768       (nnimap-update-info info (cdr (assoc group flags))))))
 769
 770 (defun nnimap-update-info (info marks)
 771   (when marks
 772     (destructuring-bind (existing flags high low uidnext start-article) marks
 773       (let ((group (gnus-info-group info))
 774             (completep (and start-article
 775                             (= start-article 1))))
 776         ;; First set the active ranges based on high/low.
 777         (if (or completep
 778                 (not (gnus-active group)))
 779             (gnus-set-active group
 780                              (if high
 781                                  (cons low high)
 782                                ;; No articles in this group.
 783                                (cons (1- uidnext) uidnext)))
 784           (setcdr (gnus-active group) high))
 785         ;; Then update the list of read articles.
 786         (let* ((unread
 787                 (gnus-compress-sequence
 788                  (gnus-set-difference
 789                   (gnus-set-difference
 790                    existing
 791                    (cdr (assoc "\\Seen" flags)))
 792                   (cdr (assoc "\\Flagged" flags)))))
 793                (read (gnus-range-difference
 794                       (cons start-article high) unread)))
 795           (when (> start-article 1)
 796             (setq read
 797                   (gnus-range-nconcat
 798                    (if (> start-article 1)
 799                        (gnus-sorted-range-intersection
 800                         (cons 1 (1- start-article))
 801                         (gnus-info-read info))
 802                      (gnus-info-read info))
 803                    read)))
 804           (gnus-info-set-read info read)
 805           ;; Update the marks.
 806           (setq marks (gnus-info-marks info))
 807           ;; Note the active level for the next run-through.
 808           (let ((active (assq 'active marks)))
 809             (if active
 810                 (setcdr active (gnus-active group))
 811               (push (cons 'active (gnus-active group)) marks)))
 812           (dolist (type (cdr nnimap-mark-alist))
 813             (let ((old-marks (assoc (car type) marks))
 814                   (new-marks (gnus-compress-sequence
 815                               (cdr (assoc (cadr type) flags)))))
 816               (setq marks (delq old-marks marks))
 817               (pop old-marks)
 818               (when (and old-marks
 819                          (> start-article 1))
 820                 (setq old-marks (gnus-range-difference
 821                                  old-marks
 822                                  (cons start-article high)))
 823                 (setq new-marks (gnus-range-nconcat old-marks new-marks)))
 824               (when new-marks
 825                 (push (cons (car type) new-marks) marks)))
 826             (gnus-info-set-marks info marks t)
 827             (nnimap-store-info info (gnus-active group))))))))
 828
 829 (defun nnimap-store-info (info active)
 830   (let* ((group (gnus-group-real-name (gnus-info-group info)))
 831          (entry (assoc group nnimap-current-infos)))
 832     (if entry
 833         (setcdr entry (list info active))
 834       (push (list group info active) nnimap-current-infos))))
 835
 836 (defun nnimap-flags-to-marks (groups)
 837   (let (data group totalp uidnext articles start-article mark)
 838     (dolist (elem groups)
 839       (setq group (car elem)
 840             uidnext (cadr elem)
 841             start-article (caddr elem)
 842             articles (cdddr elem))
 843       (let ((high (caar articles))
 844             marks low existing)
 845         (dolist (article articles)
 846           (setq low (car article))
 847           (push (car article) existing)
 848           (dolist (flag (cdr article))
 849             (setq mark (assoc flag marks))
 850             (if (not mark)
 851                 (push (list flag (car article)) marks)
 852               (setcdr mark (cons (car article) (cdr mark)))))
 853           (push (list group existing marks high low uidnext start-article)
 854                 data))))
 855     data))
 856
 857 (defun nnimap-parse-flags (sequences)
 858   (goto-char (point-min))
 859   (let (start end articles groups uidnext elems)
 860     (dolist (elem sequences)
 861       (destructuring-bind (group-sequence flag-sequence totalp group) elem
 862         ;; The EXAMINE was successful.
 863         (when (and (search-forward (format "\n%d OK " group-sequence) nil t)
 864                    (progn
 865                      (forward-line 1)
 866                      (setq start (point))
 867                      (if (re-search-backward "UIDNEXT \\([0-9]+\\)"
 868                                                (or end (point-min)) t)
 869                          (setq uidnext (string-to-number (match-string 1)))
 870                        (setq uidnext nil))
 871                      (goto-char start))
 872                    ;; The UID FETCH FLAGS was successful.
 873                    (search-forward (format "\n%d OK " flag-sequence) nil t))
 874           (setq end (point))
 875           (goto-char start)
 876           (while (re-search-forward "^\\* [0-9]+ FETCH (\\(.*\\))" end t)
 877             (setq elems (nnimap-parse-line (match-string 1)))
 878             (push (cons (string-to-number (cadr (member "UID" elems)))
 879                         (cadr (member "FLAGS" elems)))
 880                   articles))
 881           (push (nconc (list group uidnext totalp) articles) groups)
 882           (setq articles nil))))
 883     groups))
 884
 885 (defun nnimap-find-process-buffer (buffer)
 886   (cadr (assoc buffer nnimap-connection-alist)))
 887
 888 (deffoo nnimap-request-post (&optional server)
 889   (setq nnimap-status-string "Read-only server")
 890   nil)
 891
 892 (defun nnimap-possibly-change-group (group server)
 893   (let ((open-result t))
 894     (when (and server
 895                (not (nnimap-server-opened server)))
 896       (setq open-result (nnimap-open-server server)))
 897     (cond
 898      ((not open-result)
 899       nil)
 900      ((not group)
 901       t)
 902      (t
 903       (with-current-buffer (nnimap-buffer)
 904         (if (equal group (nnimap-group nnimap-object))
 905             t
 906           (let ((result (nnimap-command "SELECT %S" (utf7-encode group t))))
 907             (when (car result)
 908               (setf (nnimap-group nnimap-object) group
 909                     (nnimap-select-result nnimap-object) result)
 910               result))))))))
 911
 912 (defun nnimap-find-connection (buffer)
 913   "Find the connection delivering to BUFFER."
 914   (let ((entry (assoc buffer nnimap-connection-alist)))
 915     (when entry
 916       (if (and (buffer-name (cadr entry))
 917                (get-buffer-process (cadr entry))
 918                (memq (process-status (get-buffer-process (cadr entry)))
 919                      '(open run)))
 920           (get-buffer-process (cadr entry))
 921         (setq nnimap-connection-alist (delq entry nnimap-connection-alist))
 922         nil))))
 923
 924 (defvar nnimap-sequence 0)
 925
 926 (defun nnimap-send-command (&rest args)
 927   (process-send-string
 928    (get-buffer-process (current-buffer))
 929    (nnimap-log-command
 930     (format "%d %s%s\n"
 931             (incf nnimap-sequence)
 932             (apply #'format args)
 933             (if (nnimap-newlinep nnimap-object)
 934                 ""
 935               "\r"))))
 936   nnimap-sequence)
 937
 938 (defun nnimap-log-command (command)
 939   (with-current-buffer (get-buffer-create "*imap log*")
 940     (goto-char (point-max))
 941     (insert (format-time-string "%H:%M:%S") " " command))
 942   command)
 943
 944 (defun nnimap-command (&rest args)
 945   (erase-buffer)
 946   (let* ((sequence (apply #'nnimap-send-command args))
 947          (response (nnimap-get-response sequence)))
 948     (if (equal (caar response) "OK")
 949         (cons t response)
 950       (nnheader-report 'nnimap "%s"
 951                        (mapconcat (lambda (a)
 952                                     (format "%s" a))
 953                                   (car response) " "))
 954       nil)))
 955
 956 (defun nnimap-get-response (sequence)
 957   (nnimap-wait-for-response sequence)
 958   (nnimap-parse-response))
 959
 960 (defun nnimap-wait-for-connection ()
 961   (let ((process (get-buffer-process (current-buffer))))
 962     (goto-char (point-min))
 963     (while (and (memq (process-status process)
 964                       '(open run))
 965                 (not (re-search-forward "^\\* .*\n" nil t)))
 966       (nnheader-accept-process-output process)
 967       (goto-char (point-min)))
 968     (forward-line -1)
 969     (and (looking-at "\\* \\([A-Z0-9]+\\)")
 970          (match-string 1))))
 971
 972 (defun nnimap-wait-for-response (sequence &optional messagep)
 973   (let ((process (get-buffer-process (current-buffer))))
 974     (goto-char (point-max))
 975     (while (and (memq (process-status process)
 976                       '(open run))
 977                 (not (re-search-backward (format "^%d .*\n" sequence)
 978                                          (max (point-min) (- (point) 500))
 979                                          t)))
 980       (when messagep
 981         (message "Read %dKB" (/ (buffer-size) 1000)))
 982       (nnheader-accept-process-output process)
 983       (goto-char (point-max)))))
 984
 985 (defun nnimap-parse-response ()
 986   (let ((lines (split-string (nnimap-last-response-string) "\r\n" t))
 987         result)
 988     (dolist (line lines)
 989       (push (cdr (nnimap-parse-line line)) result))
 990     ;; Return the OK/error code first, and then all the "continuation
 991     ;; lines" afterwards.
 992     (cons (pop result)
 993           (nreverse result))))
 994
 995 ;; Parse an IMAP response line lightly.  They look like
 996 ;; "* OK [UIDVALIDITY 1164213559] UIDs valid", typically, so parse
 997 ;; the lines into a list of strings and lists of string.
 998 (defun nnimap-parse-line (line)
 999   (let (char result)
1000     (with-temp-buffer
1001       (insert line)
1002       (goto-char (point-min))
1003       (while (not (eobp))
1004         (if (eql (setq char (following-char)) ? )
1005             (forward-char 1)
1006           (push
1007            (cond
1008             ((eql char ?\[)
1009              (split-string (buffer-substring
1010                             (1+ (point)) (1- (search-forward "]")))))
1011             ((eql char ?\()
1012              (split-string (buffer-substring
1013                             (1+ (point)) (1- (search-forward ")")))))
1014             ((eql char ?\")
1015              (forward-char 1)
1016              (buffer-substring (point) (1- (search-forward "\""))))
1017             (t
1018              (buffer-substring (point) (if (search-forward " " nil t)
1019                                            (1- (point))
1020                                          (goto-char (point-max))))))
1021            result)))
1022       (nreverse result))))
1023
1024 (defun nnimap-last-response-string ()
1025   (save-excursion
1026     (forward-line 1)
1027     (let ((end (point)))
1028       (forward-line -1)
1029       (when (not (bobp))
1030         (forward-line -1)
1031         (while (and (not (bobp))
1032                     (eql (following-char) ?*))
1033           (forward-line -1))
1034         (unless (eql (following-char) ?*)
1035           (forward-line 1)))
1036       (buffer-substring (point) end))))
1037
1038 (defun nnimap-get-responses (sequences)
1039   (let (responses)
1040     (dolist (sequence sequences)
1041       (goto-char (point-min))
1042       (when (re-search-forward (format "^%d " sequence) nil t)
1043         (push (list sequence (nnimap-parse-response))
1044               responses)))
1045     responses))
1046
1047 (defvar nnimap-incoming-split-list nil)
1048
1049 (defun nnimap-fetch-inbox (articles)
1050   (erase-buffer)
1051   (nnimap-wait-for-response
1052    (nnimap-send-command
1053     "UID FETCH %s %s"
1054     (nnimap-article-ranges articles)
1055     (format "(UID %s%s)"
1056             (format
1057              (if (member "IMAP4REV1"
1058                          (nnimap-capabilities nnimap-object))
1059                  "BODY.PEEK[HEADER] BODY.PEEK"
1060                "RFC822.PEEK"))
1061             (if nnimap-split-download-body-default
1062                 "[]"
1063               "[1]")))
1064    t))
1065
1066 (defun nnimap-split-incoming-mail ()
1067   (with-current-buffer (nnimap-buffer)
1068     (let ((nnimap-incoming-split-list nil)
1069           (nnmail-split-methods nnimap-split-methods)
1070           (nnmail-inhibit-default-split-group t)
1071           (groups (nnimap-get-groups))
1072           new-articles)
1073       (erase-buffer)
1074       (nnimap-command "SELECT %S" nnimap-inbox)
1075       (setq new-articles (nnimap-new-articles (nnimap-get-flags "1:*")))
1076       (when new-articles
1077         (nnimap-fetch-inbox new-articles)
1078         (nnimap-transform-split-mail)
1079         (nnheader-ms-strip-cr)
1080         (nnmail-cache-open)
1081         (nnmail-split-incoming (current-buffer)
1082                                #'nnimap-save-mail-spec
1083                                nil nil
1084                                #'nnimap-dummy-active-number)
1085         (when nnimap-incoming-split-list
1086           (let ((specs (nnimap-make-split-specs nnimap-incoming-split-list))
1087                 sequences)
1088             ;; Create any groups that doesn't already exist on the
1089             ;; server first.
1090             (dolist (spec specs)
1091               (unless (member (car spec) groups)
1092                 (nnimap-command "CREATE %S" (utf7-encode (car spec) t))))
1093             ;; Then copy over all the messages.
1094             (erase-buffer)
1095             (dolist (spec specs)
1096               (let ((group (car spec))
1097                     (ranges (cdr spec)))
1098                 (push (list (nnimap-send-command "UID COPY %s %S"
1099                                                  (nnimap-article-ranges ranges)
1100                                                  (utf7-encode group t))
1101                             ranges)
1102                       sequences)))
1103             ;; Wait for the last COPY response...
1104             (when sequences
1105               (nnimap-wait-for-response (caar sequences))
1106               ;; And then mark the successful copy actions as deleted,
1107               ;; and possibly expunge them.
1108               (nnimap-mark-and-expunge-incoming
1109                (nnimap-parse-copied-articles sequences)))))))))
1110
1111 (defun nnimap-mark-and-expunge-incoming (range)
1112   (when range
1113     (setq range (nnimap-article-ranges range))
1114     (let ((sequence
1115            (nnimap-send-command
1116             "UID STORE %s +FLAGS.SILENT (\\Deleted)" range)))
1117       (cond
1118        ;; If the server supports it, we now delete the message we have
1119        ;; just copied over.
1120        ((member "UIDPLUS" (nnimap-capabilities nnimap-object))
1121         (setq sequence (nnimap-send-command "UID EXPUNGE %s" range)))
1122        ;; If it doesn't support UID EXPUNGE, then we only expunge if the
1123        ;; user has configured it.
1124        (nnimap-expunge-inbox
1125         (setq sequence (nnimap-send-command "EXPUNGE"))))
1126       (nnimap-wait-for-response sequence))))
1127
1128 (defun nnimap-parse-copied-articles (sequences)
1129   (let (sequence copied range)
1130     (goto-char (point-min))
1131     (while (re-search-forward "^\\([0-9]+\\) OK " nil t)
1132       (setq sequence (string-to-number (match-string 1)))
1133       (when (setq range (cadr (assq sequence sequences)))
1134         (push (gnus-uncompress-range range) copied)))
1135     (gnus-compress-sequence (sort (apply #'nconc copied) #'<))))
1136
1137 (defun nnimap-new-articles (flags)
1138   (let (new)
1139     (dolist (elem flags)
1140       (when (or (null (cdr elem))
1141                 (and (not (member "\\Deleted" (cdr elem)))
1142                      (not (member "\\Seen" (cdr elem)))))
1143         (push (car elem) new)))
1144     (gnus-compress-sequence (nreverse new))))
1145
1146 (defun nnimap-make-split-specs (list)
1147   (let ((specs nil)
1148         entry)
1149     (dolist (elem list)
1150       (destructuring-bind (article spec) elem
1151         (dolist (group (delete nil (mapcar #'car spec)))
1152           (unless (setq entry (assoc group specs))
1153             (push (setq entry (list group)) specs))
1154           (setcdr entry (cons article (cdr entry))))))
1155     (dolist (entry specs)
1156       (setcdr entry (gnus-compress-sequence (sort (cdr entry) #'<))))
1157     specs))
1158
1159 (defun nnimap-transform-split-mail ()
1160   (goto-char (point-min))
1161   (let (article bytes)
1162     (block nil
1163       (while (not (eobp))
1164         (while (not (looking-at "^\\* [0-9]+ FETCH.*UID \\([0-9]+\\)"))
1165           (delete-region (point) (progn (forward-line 1) (point)))
1166           (when (eobp)
1167             (return)))
1168         (setq article (match-string 1)
1169               bytes (nnimap-get-length))
1170         (delete-region (line-beginning-position) (line-end-position))
1171         ;; Insert MMDF separator, and a way to remember what this
1172         ;; article UID is.
1173         (insert (format "\^A\^A\^A\^A\n\nX-nnimap-article: %s" article))
1174         (forward-char (1+ bytes))
1175         (setq bytes (nnimap-get-length))
1176         (delete-region (line-beginning-position) (line-end-position))
1177         (forward-char (1+ bytes))
1178         (delete-region (line-beginning-position) (line-end-position))))))
1179
1180 (defun nnimap-dummy-active-number (group &optional server)
1181   1)
1182
1183 (defun nnimap-save-mail-spec (group-art &optional server full-nov)
1184   (let (article)
1185     (goto-char (point-min))
1186     (if (not (re-search-forward "X-nnimap-article: \\([0-9]+\\)" nil t))
1187         (error "Invalid nnimap mail")
1188       (setq article (string-to-number (match-string 1))))
1189     (push (list article group-art)
1190           nnimap-incoming-split-list)))
1191
1192 (provide 'nnimap)
1193
1194 ;;; nnimap.el ends here