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

   1 ;;; nnimap.el --- imap backend for Gnus
   2 ;; Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
   3
   4 ;; Author: Simon Josefsson <jas@pdc.kth.se>
   5 ;;         Jim Radford <radford@robby.caltech.edu>
   6 ;; Keywords: mail
   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 2, or (at your option)
  13 ;; 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; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;; Todo, major things:
  28 ;;
  29 ;;   o Fix Gnus to view correct number of unread/total articles in group buffer
  30 ;;   o Fix Gnus to handle leading '.' in group names (fixed?)
  31 ;;   o Finish disconnected mode (moving articles between mailboxes unplugged)
  32 ;;   o Sieve
  33 ;;   o MIME (partial article fetches)
  34 ;;   o Split to other backends, different split rules for different
  35 ;;     servers/inboxes
  36 ;;
  37 ;; Todo, minor things:
  38 ;;
  39 ;;   o Don't require half of Gnus -- backends should be standalone
  40 ;;   o Verify that we don't use IMAP4rev1 specific things (RFC2060 App B)
  41 ;;   o Dont uid fetch 1,* in nnimap-retrive-groups (slow)
  42 ;;   o Split up big fetches (1,* header especially) in smaller chunks
  43 ;;   o What do I do with gnus-newsgroup-*?
  44 ;;   o Tell Gnus about new groups (how can we tell?)
  45 ;;   o Respooling (fix Gnus?) (unnecessery?)
  46 ;;   o Add support for the following: (if applicable)
  47 ;;       request-list-newsgroups, request-regenerate
  48 ;;       list-active-group,
  49 ;;       request-associate-buffer, request-restore-buffer,
  50 ;;   o Do The Right Thing when UIDVALIDITY changes (what's the right thing?)
  51 ;;   o Support RFC2221 (Login referrals)
  52 ;;   o IMAP2BIS compatibility? (RFC2061)
  53 ;;   o ACAP stuff (perhaps a different project, would be nice to ACAPify
  54 ;;     .newsrc.eld)
  55 ;;   o What about Gnus's article editing, can we support it?  NO!
  56 ;;   o Use \Draft to support the draft group??
  57 ;;   o Duplicate suppression
  58
  59 ;;; Code:
  60
  61 (eval-and-compile
  62   (require 'imap))
  63
  64 (require 'nnoo)
  65 (require 'nnmail)
  66 (require 'nnheader)
  67 (require 'mm-util)
  68 (require 'gnus)
  69 (require 'gnus-range)
  70 (require 'gnus-start)
  71 (require 'gnus-int)
  72
  73 (nnoo-declare nnimap)
  74
  75 (defconst nnimap-version "nnimap 0.131")
  76
  77 (defvoo nnimap-address nil
  78   "Address of physical IMAP server.  If nil, use the virtual server's name.")
  79
  80 (defvoo nnimap-server-port nil
  81   "Port number on physical IMAP server.
  82 If nil, defaults to 993 for SSL connections and 143 otherwise.")
  83
  84 ;; Splitting variables
  85
  86 (defvar nnimap-split-crosspost t
  87   "If non-nil, do crossposting if several split methods match the mail.
  88 If nil, the first match found will be used.")
  89
  90 (defvar nnimap-split-inbox nil
  91   "*Name of mailbox to split mail from.
  92
  93 Mail is read from this mailbox and split according to rules in
  94 `nnimap-split-rules'.
  95
  96 This can be a string or a list of strings.")
  97
  98 (defvar nnimap-split-rule nil
  99   "*Mail will be split according to theese rules.
 100
 101 Mail is read from mailbox(es) specified in `nnimap-split-inbox'.
 102
 103 If you'd like, for instance, one mail group for mail from the
 104 \"gnus-imap\" mailing list, one group for junk mail and leave
 105 everything else in the incoming mailbox, you could do something like
 106 this:
 107
 108 (setq nnimap-split-rule '((\"INBOX.gnus-imap\"   \"From:.*gnus-imap\")
 109                           (\"INBOX.junk\"        \"Subject:.*buy\")))
 110
 111 As you can see, `nnimap-split-rule' is a list of lists, where the first
 112 element in each \"rule\" is the name of the IMAP mailbox, and the
 113 second is a regexp that nnimap will try to match on the header to find
 114 a fit.
 115
 116 The second element can also be a function.  In that case, it will be
 117 called narrowed to the headers with the first element of the rule as
 118 the argument.  It should return a non-nil value if it thinks that the
 119 mail belongs in that group.
 120
 121 This variable can also have a function as its value, the function will
 122 be called with the headers narrowed and should return a group where it
 123 thinks the article should be splitted to.  See `nnimap-split-fancy'.
 124
 125 To allow for different split rules on different virtual servers, and
 126 even different split rules in different inboxes on the same server,
 127 the syntax of this variable have been extended along the lines of:
 128
 129 (setq nnimap-split-rule
 130       '((\"my1server\"    (\".*\"    ((\"ding\"    \"ding@gnus.org\")
 131                                   (\"junk\"    \"From:.*Simon\")))
 132         (\"my2server\"    (\"INBOX\" nnimap-split-fancy))
 133         (\"my[34]server\" (\".*\"    ((\"private\" \"To:.*Simon\")
 134                                   (\"junk\"    my-junk-func)))))
 135
 136 The virtual server name is in fact a regexp, so that the same rules
 137 may apply to several servers.  In the example, the servers
 138 \"my3server\" and \"my4server\" both use the same rules.  Similarly,
 139 the inbox string is also a regexp.  The actual splitting rules are as
 140 before, either a function, or a list with group/regexp or
 141 group/function elements.")
 142
 143 (defvar nnimap-split-predicate "UNSEEN UNDELETED"
 144   "The predicate used to find articles to split.
 145 If you use another IMAP client to peek on articles but always would
 146 like nnimap to split them once it's started, you could change this to
 147 \"UNDELETED\". Other available predicates are available in
 148 RFC2060 section 6.4.4.")
 149
 150 (defvar nnimap-split-fancy nil
 151   "Like `nnmail-split-fancy', which see.")
 152
 153 ;; Authorization / Privacy variables
 154
 155 (defvoo nnimap-auth-method nil
 156   "Obsolete.")
 157
 158 (defvoo nnimap-stream nil
 159   "How nnimap will connect to the server.
 160
 161 The default, nil, will try to use the \"best\" method the server can
 162 handle.
 163
 164 Change this if
 165
 166 1) you want to connect with SSL.  The SSL integration with IMAP is
 167    brain-dead so you'll have to tell it specifically.
 168
 169 2) your server is more capable than your environment -- i.e. your
 170    server accept Kerberos login's but you haven't installed the
 171    `imtest' program or your machine isn't configured for Kerberos.
 172
 173 Possible choices: kerberos4, ssl, network")
 174
 175 (defvoo nnimap-authenticator nil
 176   "How nnimap authenticate itself to the server.
 177
 178 The default, nil, will try to use the \"best\" method the server can
 179 handle.
 180
 181 There is only one reason for fiddling with this variable, and that is
 182 if your server is more capable than your environment -- i.e. you
 183 connect to a server that accept Kerberos login's but you haven't
 184 installed the `imtest' program or your machine isn't configured for
 185 Kerberos.
 186
 187 Possible choices: kerberos4, cram-md5, login, anonymous.")
 188
 189 (defvoo nnimap-directory (nnheader-concat gnus-directory "overview/")
 190   "Directory to keep NOV cache files for nnimap groups.
 191 See also `nnimap-nov-file-name'.")
 192
 193 (defvoo nnimap-nov-file-name "nnimap."
 194   "NOV cache base filename.
 195 The group name and `nnimap-nov-file-name-suffix' will be appended.  A
 196 typical complete file name would be
 197 ~/News/overview/nnimap.pdc.INBOX.ding.nov, or
 198 ~/News/overview/nnimap/pdc/INBOX/ding/nov if
 199 `nnmail-use-long-file-names' is nil")
 200
 201 (defvoo nnimap-nov-file-name-suffix ".novcache"
 202   "Suffix for NOV cache base filename.")
 203
 204 (defvoo nnimap-nov-is-evil nil
 205   "If non-nil, nnimap will never generate or use a local nov database for this backend.
 206 Using nov databases will speed up header fetching considerably.
 207 Unlike other backends, you do not need to take special care if you
 208 flip this variable.")
 209
 210 (defvoo nnimap-expunge-on-close 'always ; 'ask, 'never
 211   "Whether to expunge a group when it is closed.
 212 When a IMAP group with articles marked for deletion is closed, this
 213 variable determine if nnimap should actually remove the articles or
 214 not.
 215
 216 If always, nnimap always perform a expunge when closing the group.
 217 If never, nnimap never expunges articles marked for deletion.
 218 If ask, nnimap will ask you if you wish to expunge marked articles.
 219
 220 When setting this variable to `never', you can only expunge articles
 221 by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")
 222
 223 (defvoo nnimap-list-pattern "*"
 224   "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
 225 See below for available wildcards.
 226
 227 The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
 228 REFERENCE will be passed as the first parameter to LIST/LSUB.  The
 229 semantics of this are server specific, on the University of Washington
 230 server you can specify a directory.
 231
 232 Example:
 233  '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))
 234
 235 There are two wildcards * and %. * matches everything, % matches
 236 everything in the current hierarchy.")
 237
 238 (defvoo nnimap-news-groups nil
 239   "IMAP support a news-like mode, also known as bulletin board mode, where replies is sent via IMAP instead of SMTP.
 240
 241 This variable should contain a regexp matching groups where you wish
 242 replies to be stored to the mailbox directly.
 243
 244 Example:
 245   '(\"^[^I][^N][^B][^O][^X].*$\")
 246
 247 This will match all groups not beginning with \"INBOX\".
 248
 249 Note that there is nothing technically different between mail-like and
 250 news-like mailboxes.  If you wish to have a group with todo items or
 251 similar which you wouldn't want to set up a mailing list for, you can
 252 use this to make replies go directly to the group.")
 253
 254 (defvoo nnimap-server-address nil
 255   "Obsolete.  Use `nnimap-address'.")
 256
 257 (defcustom nnimap-authinfo-file "~/.authinfo"
 258   "Authorization information for IMAP servers.  In .netrc format."
 259   :type
 260   '(choice file
 261            (repeat :tag "Entries"
 262                    :menu-tag "Inline"
 263                    (list :format "%v"
 264                          :value ("" ("login" . "") ("password" . ""))
 265                          (string :tag "Host")
 266                          (checklist :inline t
 267                                     (cons :format "%v"
 268                                           (const :format "" "login")
 269                                           (string :format "Login: %v"))
 270                                     (cons :format "%v"
 271                                           (const :format "" "password")
 272                                           (string :format "Password: %v")))))))
 273
 274 (defcustom nnimap-prune-cache t
 275   "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
 276   :type 'boolean)
 277
 278 (defvar nnimap-request-list-method 'imap-mailbox-list
 279   "Method to use to request a list of all folders from the server.
 280 If this is 'imap-mailbox-lsub, then use a server-side subscription list to
 281 restrict visible folders.")
 282
 283 ;; Internal variables:
 284
 285 (defvar nnimap-debug nil
 286   "Name of buffer to record debugging info.
 287 For example: (setq nnimap-debug \"*nnimap-debug*\")")
 288 (defvar nnimap-current-move-server nil)
 289 (defvar nnimap-current-move-group nil)
 290 (defvar nnimap-current-move-article nil)
 291 (defvar nnimap-length)
 292 (defvar nnimap-progress-chars '(?| ?/ ?- ?\\))
 293 (defvar nnimap-progress-how-often 20)
 294 (defvar nnimap-counter)
 295 (defvar nnimap-callback-callback-function nil
 296   "Gnus callback the nnimap asynchronous callback should call.")
 297 (defvar nnimap-callback-buffer nil
 298   "Which buffer the asynchronous article prefetch callback should work in.")
 299 (defvar nnimap-server-buffer-alist nil) ;; Map server name to buffers.
 300 (defvar nnimap-current-server nil)      ;; Current server
 301 (defvar nnimap-server-buffer nil)       ;; Current servers' buffer
 302
 303 \f
 304
 305 (nnoo-define-basics nnimap)
 306
 307 ;; Utility functions:
 308
 309 (defsubst nnimap-get-server-buffer (server)
 310   "Return buffer for SERVER, if nil use current server."
 311   (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist)))
 312
 313 (defun nnimap-possibly-change-server (server)
 314   "Return buffer for SERVER, changing the current server as a side-effect.
 315 If SERVER is nil, uses the current server."
 316   (setq nnimap-current-server (or server nnimap-current-server)
 317         nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server)))
 318
 319 (defun nnimap-verify-uidvalidity (group server)
 320   "Verify stored uidvalidity match current one in GROUP on SERVER."
 321   (let* ((gnusgroup (gnus-group-prefixed-name
 322                      group (gnus-server-to-method
 323                             (format "nnimap:%s" server))))
 324          (new-uidvalidity (imap-mailbox-get 'uidvalidity))
 325          (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity)))
 326     (if old-uidvalidity
 327         (if (not (equal old-uidvalidity new-uidvalidity))
 328             nil ;; uidvalidity clash
 329           (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
 330           t)
 331       (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
 332       t)))
 333
 334 (defun nnimap-before-find-minmax-bugworkaround ()
 335   "Function called before iterating through mailboxes with
 336 `nnimap-find-minmax-uid'."
 337   ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
 338   ;; currently selected mailbox without a re-select/examine.
 339   (or (null (imap-current-mailbox nnimap-server-buffer))
 340       (imap-mailbox-unselect nnimap-server-buffer)))
 341
 342 (defun nnimap-find-minmax-uid (group &optional examine)
 343   "Find lowest and highest active article nummber in GROUP.
 344 If EXAMINE is non-nil the group is selected read-only."
 345   (with-current-buffer nnimap-server-buffer
 346     (when (imap-mailbox-select group examine)
 347       (let (minuid maxuid)
 348         (when (> (imap-mailbox-get 'exists) 0)
 349           (imap-fetch "1,*" "UID" nil 'nouidfetch)
 350           (imap-message-map (lambda (uid Uid)
 351                               (setq minuid (if minuid (min minuid uid) uid)
 352                                     maxuid (if maxuid (max maxuid uid) uid)))
 353                             'UID))
 354         (list (imap-mailbox-get 'exists) minuid maxuid)))))
 355
 356 (defun nnimap-possibly-change-group (group &optional server)
 357   "Make GROUP the current group, and SERVER the current server."
 358   (when (nnimap-possibly-change-server server)
 359     (with-current-buffer nnimap-server-buffer
 360       (if (or (null group) (imap-current-mailbox-p group))
 361           imap-current-mailbox
 362         (if (imap-mailbox-select group)
 363             (if (or (nnimap-verify-uidvalidity
 364                      group (or server nnimap-current-server))
 365                     (zerop (imap-mailbox-get 'exists group))
 366                     (yes-or-no-p
 367                      (format
 368                       "nnimap: Group %s is not uidvalid.  Continue? " group)))
 369                 imap-current-mailbox
 370               (imap-mailbox-unselect)
 371               (error "nnimap: Group %s is not uid-valid." group))
 372           (nnheader-report 'nnimap (imap-error-text)))))))
 373
 374 (defun nnimap-replace-whitespace (string)
 375   "Return STRING with all whitespace replaced with space."
 376   (when string
 377     (while (string-match "[\r\n\t]+" string)
 378       (setq string (replace-match " " t t string)))
 379     string))
 380
 381 ;; Required backend functions
 382
 383 (defun nnimap-retrieve-headers-progress ()
 384   "Hook to insert NOV line for current article into `nntp-server-buffer'."
 385   (and (numberp nnmail-large-newsgroup)
 386        (zerop (% (incf nnimap-counter) nnimap-progress-how-often))
 387        (> nnimap-length nnmail-large-newsgroup)
 388        (nnheader-message 6 "nnimap: Retrieving headers... %c"
 389                          (nth (/ (% nnimap-counter
 390                                     (* (length nnimap-progress-chars)
 391                                        nnimap-progress-how-often))
 392                                  nnimap-progress-how-often)
 393                               nnimap-progress-chars)))
 394   (with-current-buffer nntp-server-buffer
 395     (let (headers lines chars uid mbx)
 396       (with-current-buffer nnimap-server-buffer
 397         (setq uid imap-current-message
 398               mbx imap-current-mailbox
 399               headers (if (imap-capability 'IMAP4rev1)
 400                           ;; xxx don't just use car? alist doesn't contain
 401                           ;; anything else now, but it might...
 402                           (nth 2 (car (imap-message-get uid 'BODYDETAIL)))
 403                         (imap-message-get uid 'RFC822.HEADER))
 404               lines (imap-body-lines (imap-message-body imap-current-message))
 405               chars (imap-message-get imap-current-message 'RFC822.SIZE)))
 406       (nnheader-insert-nov
 407        (with-temp-buffer
 408          (buffer-disable-undo)
 409          (insert headers)
 410          (nnheader-ms-strip-cr)
 411          (nnheader-fold-continuation-lines)
 412          (subst-char-in-region (point-min) (point-max) ?\t ? )
 413          (let ((head (nnheader-parse-head 'naked)))
 414            (mail-header-set-number head uid)
 415            (mail-header-set-chars head chars)
 416            (mail-header-set-lines head lines)
 417            (mail-header-set-xref
 418             head (format "%s %s:%d" (system-name) mbx uid))
 419            head))))))
 420
 421 (defun nnimap-retrieve-which-headers (articles fetch-old)
 422   "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
 423   (with-current-buffer nnimap-server-buffer
 424     (if (numberp (car-safe articles))
 425         (imap-search
 426          (concat "UID "
 427                  (imap-range-to-message-set
 428                   (gnus-compress-sequence
 429                    (append (gnus-uncompress-sequence
 430                             (and fetch-old
 431                                  (cons (if (numberp fetch-old)
 432                                            (max 1 (- (car articles) fetch-old))
 433                                          1)
 434                                        (1- (car articles)))))
 435                            articles)))))
 436       (mapcar (lambda (msgid)
 437                 (imap-search
 438                  (format "HEADER Message-Id %s" msgid)))
 439               articles))))
 440
 441 (defun nnimap-group-overview-filename (group server)
 442   "Make pathname for GROUP on SERVER."
 443   (let ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
 444         (file (nnheader-translate-file-chars
 445                (concat nnimap-nov-file-name
 446                        (if (equal server "")
 447                            "unnamed"
 448                          server) "." group nnimap-nov-file-name-suffix) t)))
 449     (if (or nnmail-use-long-file-names
 450             (file-exists-p (concat dir file)))
 451         (concat dir file)
 452       (concat dir (mm-encode-coding-string
 453                    (nnheader-replace-chars-in-string file ?. ?/)
 454                    nnmail-pathname-coding-system)))))
 455
 456 (defun nnimap-retrieve-headers-from-file (group server)
 457   (with-current-buffer nntp-server-buffer
 458     (let ((nov (nnimap-group-overview-filename group server)))
 459       (when (file-exists-p nov)
 460         (mm-insert-file-contents nov)
 461         (set-buffer-modified-p nil)
 462         (let ((min (ignore-errors (goto-char (point-min))
 463                                   (read (current-buffer))))
 464               (max (ignore-errors (goto-char (point-max))
 465                                   (forward-line -1)
 466                                   (read (current-buffer)))))
 467           (if (and (numberp min) (numberp max))
 468               (cons min max)
 469             ;; junk, remove it, it's saved later
 470             (erase-buffer)
 471             nil))))))
 472
 473 (defun nnimap-retrieve-headers-from-server (articles group server)
 474   (with-current-buffer nnimap-server-buffer
 475     (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
 476           (nnimap-length (gnus-range-length articles))
 477           (nnimap-counter 0))
 478       (imap-fetch (imap-range-to-message-set articles)
 479                   (concat "(UID RFC822.SIZE BODY "
 480                           (let ((headers
 481                                  (append '(Subject From Date Message-Id
 482                                                    References In-Reply-To Xref)
 483                                          (copy-sequence
 484                                           nnmail-extra-headers))))
 485                             (if (imap-capability 'IMAP4rev1)
 486                                 (format "BODY.PEEK[HEADER.FIELDS %s])" headers)
 487                               (format "RFC822.HEADER.LINES %s)" headers)))))
 488       (and (numberp nnmail-large-newsgroup)
 489            (> nnimap-length nnmail-large-newsgroup)
 490            (nnheader-message 6 "nnimap: Retrieving headers...done")))))
 491
 492 (defun nnimap-use-nov-p (group server)
 493   (or gnus-nov-is-evil nnimap-nov-is-evil
 494       (unless (and (gnus-make-directory
 495                     (file-name-directory
 496                      (nnimap-group-overview-filename group server)))
 497                    (file-writable-p
 498                     (nnimap-group-overview-filename group server)))
 499         (message "nnimap: Nov cache not writable, %s"
 500                  (nnimap-group-overview-filename group server)))))
 501
 502 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
 503   (when (nnimap-possibly-change-group group server)
 504     (with-current-buffer nntp-server-buffer
 505       (erase-buffer)
 506       (if (nnimap-use-nov-p group server)
 507           (nnimap-retrieve-headers-from-server
 508            (gnus-compress-sequence articles) group server)
 509         (let (uids cached low high)
 510           (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
 511                       low (car uids)
 512                       high (car (last uids)))
 513             (if (setq cached (nnimap-retrieve-headers-from-file group server))
 514                 (progn
 515                   ;; fetch articles with uids before cache block
 516                   (when (< low (car cached))
 517                     (goto-char (point-min))
 518                     (nnimap-retrieve-headers-from-server
 519                      (cons low (1- (car cached))) group server))
 520                   ;; fetch articles with uids after cache block
 521                   (when (> high (cdr cached))
 522                     (goto-char (point-max))
 523                     (nnimap-retrieve-headers-from-server
 524                      (cons (1+ (cdr cached)) high) group server))
 525                   (when nnimap-prune-cache
 526                     ;; remove nov's for articles which has expired on server
 527                     (goto-char (point-min))
 528                     (dolist (uid (gnus-set-difference articles uids))
 529                       (when (re-search-forward (format "^%d\t" uid) nil t)
 530                         (gnus-delete-line)))))
 531               ;; nothing cached, fetch whole range from server
 532               (nnimap-retrieve-headers-from-server
 533                (cons low high) group server))
 534             (when (buffer-modified-p)
 535               (nnmail-write-region
 536                1 (point-max) (nnimap-group-overview-filename group server)
 537                nil 'nomesg))
 538             (nnheader-nov-delete-outside-range low high))))
 539       'nov)))
 540
 541 (defun nnimap-open-connection (server)
 542   (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
 543                       nnimap-authenticator nnimap-server-buffer))
 544       (nnheader-report 'nnimap "Can't open connection to server %s" server)
 545     (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
 546                 (imap-capability 'IMAP4rev1 nnimap-server-buffer))
 547       (imap-close nnimap-server-buffer)
 548       (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
 549     (let* ((list (gnus-parse-netrc nnimap-authinfo-file))
 550            (port (if nnimap-server-port
 551                      (int-to-string nnimap-server-port)
 552                    "imap"))
 553            (alist (gnus-netrc-machine list (or nnimap-server-address
 554                                                nnimap-address server)
 555                                       port "imap"))
 556            (user (gnus-netrc-get alist "login"))
 557            (passwd (gnus-netrc-get alist "password")))
 558       (if (imap-authenticate user passwd nnimap-server-buffer)
 559           (prog1
 560               (push (list server nnimap-server-buffer)
 561                     nnimap-server-buffer-alist)
 562             (nnimap-possibly-change-server server))
 563         (imap-close nnimap-server-buffer)
 564         (kill-buffer nnimap-server-buffer)
 565         (nnheader-report 'nnimap "Could not authenticate to %s" server)))))
 566
 567 (deffoo nnimap-open-server (server &optional defs)
 568   (nnheader-init-server-buffer)
 569   (if (nnimap-server-opened server)
 570       t
 571     (unless (assq 'nnimap-server-buffer defs)
 572       (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
 573     ;; translate `nnimap-server-address' to `nnimap-address' in defs
 574     ;; for people that configured nnimap with a very old version
 575     (unless (assq 'nnimap-address defs)
 576       (if (assq 'nnimap-server-address defs)
 577           (push (list 'nnimap-address
 578                       (cadr (assq 'nnimap-server-address defs))) defs)
 579         (push (list 'nnimap-address server) defs)))
 580     (nnoo-change-server 'nnimap server defs)
 581     (or (and nnimap-server-buffer
 582              (imap-opened nnimap-server-buffer))
 583         (nnimap-open-connection server))))
 584
 585 (deffoo nnimap-server-opened (&optional server)
 586   "Whether SERVER is opened.
 587 If SERVER is the current virtual server, and the connection to the
 588 physical server is alive, this function return a non-nil value.  If
 589 SERVER is nil, it is treated as the current server."
 590   ;; clean up autologouts??
 591   (and (or server nnimap-current-server)
 592        (nnoo-server-opened 'nnimap (or server nnimap-current-server))
 593        (imap-opened (nnimap-get-server-buffer server))))
 594
 595 (deffoo nnimap-close-server (&optional server)
 596   "Close connection to server and free all resources connected to it.
 597 Return nil if the server couldn't be closed for some reason."
 598   (let ((server (or server nnimap-current-server)))
 599     (when (or (nnimap-server-opened server)
 600               (imap-opened (nnimap-get-server-buffer server)))
 601       (imap-close (nnimap-get-server-buffer server))
 602       (kill-buffer (nnimap-get-server-buffer server))
 603       (setq nnimap-server-buffer nil
 604             nnimap-current-server nil
 605             nnimap-server-buffer-alist
 606             (delq server nnimap-server-buffer-alist)))
 607     (nnoo-close-server 'nnimap server)))
 608
 609 (deffoo nnimap-request-close ()
 610   "Close connection to all servers and free all resources that the backend have reserved.
 611 All buffers that have been created by that
 612 backend should be killed.  (Not the nntp-server-buffer, though.) This
 613 function is generally only called when Gnus is shutting down."
 614   (mapcar (lambda (server) (nnimap-close-server (car server)))
 615           nnimap-server-buffer-alist)
 616   (setq nnimap-server-buffer-alist nil))
 617
 618 (deffoo nnimap-status-message (&optional server)
 619   "This function returns the last error message from server."
 620   (when (nnimap-possibly-change-server server)
 621     (nnoo-status-message 'nnimap server)))
 622
 623 (defun nnimap-demule (string)
 624   (funcall (if (and (fboundp 'string-as-multibyte)
 625                     (subrp (symbol-function 'string-as-multibyte)))
 626                'string-as-multibyte
 627              'identity)
 628            (or string "")))
 629
 630 (defun nnimap-callback ()
 631   (remove-hook 'imap-fetch-data-hook 'nnimap-callback)
 632   (with-current-buffer nnimap-callback-buffer
 633     (insert
 634      (with-current-buffer nnimap-server-buffer
 635        (nnimap-demule
 636         (if (imap-capability 'IMAP4rev1)
 637             ;; xxx don't just use car? alist doesn't contain
 638             ;; anything else now, but it might...
 639             (nth 2 (car (imap-message-get (imap-current-message) 'BODYDETAIL)))
 640           (imap-message-get (imap-current-message) 'RFC822)))))
 641     (nnheader-ms-strip-cr)
 642     (funcall nnimap-callback-callback-function t)))
 643
 644 (defun nnimap-request-article-part (article part prop &optional
 645                                             group server to-buffer detail)
 646   (when (nnimap-possibly-change-group group server)
 647     (let ((article (if (stringp article)
 648                        (car-safe (imap-search
 649                                   (format "HEADER Message-Id %s" article)
 650                                   nnimap-server-buffer))
 651                      article)))
 652       (when article
 653         (gnus-message 10 "nnimap: Fetching (part of) article %d..." article)
 654         (if (not nnheader-callback-function)
 655             (with-current-buffer (or to-buffer nntp-server-buffer)
 656               (erase-buffer)
 657               (let ((data (imap-fetch article part prop nil
 658                                       nnimap-server-buffer)))
 659                 (insert (nnimap-demule (if detail
 660                                            (nth 2 (car data))
 661                                          data))))
 662               (nnheader-ms-strip-cr)
 663               (gnus-message 10 "nnimap: Fetching (part of) article %d...done"
 664                             article)
 665               (if (bobp)
 666                   (nnheader-report 'nnimap "No such article: %s"
 667                                    (imap-error-text nnimap-server-buffer))
 668                 (cons group article)))
 669           (add-hook 'imap-fetch-data-hook 'nnimap-callback)
 670           (setq nnimap-callback-callback-function nnheader-callback-function
 671                 nnimap-callback-buffer nntp-server-buffer)
 672           (imap-fetch-asynch article part nil nnimap-server-buffer)
 673           (cons group article))))))
 674
 675 (deffoo nnimap-asynchronous-p ()
 676   t)
 677
 678 (deffoo nnimap-request-article (article &optional group server to-buffer)
 679   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 680       (nnimap-request-article-part
 681        article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail)
 682     (nnimap-request-article-part
 683      article "RFC822.PEEK" 'RFC822 group server to-buffer)))
 684
 685 (deffoo nnimap-request-head (article &optional group server to-buffer)
 686   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 687       (nnimap-request-article-part
 688        article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail)
 689     (nnimap-request-article-part
 690      article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer)))
 691
 692 (deffoo nnimap-request-body (article &optional group server to-buffer)
 693   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 694       (nnimap-request-article-part
 695        article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail)
 696     (nnimap-request-article-part
 697      article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer)))
 698
 699 (deffoo nnimap-request-group (group &optional server fast)
 700   (nnimap-request-update-info-internal
 701    group
 702    (gnus-get-info (gnus-group-prefixed-name
 703                    group (gnus-server-to-method (format "nnimap:%s" server))))
 704    server)
 705   (when (nnimap-possibly-change-group group server)
 706     (nnimap-before-find-minmax-bugworkaround)
 707     (let (info)
 708       (cond (fast group)
 709             ((null (setq info (nnimap-find-minmax-uid group t)))
 710              (nnheader-report 'nnimap "Could not get active info for %s"
 711                               group))
 712             (t
 713              (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0)
 714                               (max 1 (or (nth 1 info) 1))
 715                               (or (nth 2 info) 0) group)
 716              (nnheader-report 'nnimap "Group %s selected" group)
 717              t)))))
 718
 719 (defun nnimap-close-group (group &optional server)
 720   (with-current-buffer nnimap-server-buffer
 721     (when (and (imap-opened)
 722                (nnimap-possibly-change-group group server))
 723       (case nnimap-expunge-on-close
 724         ('always (imap-mailbox-expunge)
 725                  (imap-mailbox-close))
 726         ('ask (if (and (imap-search "DELETED")
 727                        (gnus-y-or-n-p (format
 728                                        "Expunge articles in group `%s'? "
 729                                        imap-current-mailbox)))
 730                   (progn (imap-mailbox-expunge)
 731                          (imap-mailbox-close))
 732                 (imap-mailbox-unselect)))
 733         (t (imap-mailbox-unselect)))
 734       (not imap-current-mailbox))))
 735
 736 (defun nnimap-pattern-to-list-arguments (pattern)
 737   (mapcar (lambda (p)
 738             (cons (car-safe p) (or (cdr-safe p) p)))
 739           (if (and (listp pattern)
 740                    (listp (cdr pattern)))
 741               pattern
 742             (list pattern))))
 743
 744 (deffoo nnimap-request-list (&optional server)
 745   (when (nnimap-possibly-change-server server)
 746     (with-current-buffer nntp-server-buffer
 747       (erase-buffer))
 748     (gnus-message 5 "nnimap: Generating active list%s..."
 749                   (if (> (length server) 0) (concat " for " server) ""))
 750     (nnimap-before-find-minmax-bugworkaround)
 751     (with-current-buffer nnimap-server-buffer
 752       (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern))
 753         (dolist (mbx (funcall nnimap-request-list-method
 754                               (cdr pattern) (car pattern)))
 755           (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx))
 756               (let ((info (nnimap-find-minmax-uid mbx 'examine)))
 757                 (when info
 758                   (with-current-buffer nntp-server-buffer
 759                    (insert (format "\"%s\" %d %d y\n"
 760                                    mbx (or (nth 2 info) 0)
 761                                    (max 1 (or (nth 1 info) 1)))))))))))
 762     (gnus-message 5 "nnimap: Generating active list%s...done"
 763                   (if (> (length server) 0) (concat " for " server) ""))
 764     t))
 765
 766 (deffoo nnimap-request-post (&optional server)
 767   (let ((success t))
 768     (dolist (mbx (message-unquote-tokens
 769                   (message-tokenize-header
 770                    (message-fetch-field "Newsgroups") ", ")) success)
 771       (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
 772         (or (gnus-active to-newsgroup)
 773             (gnus-activate-group to-newsgroup)
 774             (if (gnus-y-or-n-p (format "No such group: %s.  Create it? "
 775                                        to-newsgroup))
 776                 (or (and (gnus-request-create-group
 777                           to-newsgroup gnus-command-method)
 778                          (gnus-activate-group to-newsgroup nil nil
 779                                               gnus-command-method))
 780                     (error "Couldn't create group %s" to-newsgroup)))
 781             (error "No such group: %s" to-newsgroup))
 782         (unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method))
 783           (setq success nil))))))
 784
 785 ;; Optional backend functions
 786
 787 (deffoo nnimap-retrieve-groups (groups &optional server)
 788   (when (nnimap-possibly-change-server server)
 789     (gnus-message 5 "nnimap: Checking mailboxes...")
 790     (with-current-buffer nntp-server-buffer
 791       (erase-buffer)
 792       (nnimap-before-find-minmax-bugworkaround)
 793       (dolist (group groups)
 794         (gnus-message 7 "nnimap: Checking mailbox %s" group)
 795         (or (member "\\NoSelect"
 796                     (imap-mailbox-get 'list-flags group nnimap-server-buffer))
 797             (let ((info (nnimap-find-minmax-uid group 'examine)))
 798               (insert (format "\"%s\" %d %d y\n" group
 799                               (or (nth 2 info) 0)
 800                               (max 1 (or (nth 1 info) 1))))))))
 801     (gnus-message 5 "nnimap: Checking mailboxes...done")
 802     'active))
 803
 804 (deffoo nnimap-request-update-info-internal (group info &optional server)
 805   (when (nnimap-possibly-change-group group server)
 806     (when info;; xxx what does this mean? should we create a info?
 807       (with-current-buffer nnimap-server-buffer
 808         (gnus-message 5 "nnimap: Updating info for %s..."
 809                       (gnus-info-group info))
 810
 811         (when (nnimap-mark-permanent-p 'read)
 812           (let (seen unseen)
 813             ;; read info could contain articles marked unread by other
 814             ;; imap clients!  we correct this
 815             (setq seen (gnus-uncompress-range (gnus-info-read info))
 816                   unseen (imap-search "UNSEEN UNDELETED")
 817                   seen (gnus-set-difference seen unseen)
 818                   ;; seen might lack articles marked as read by other
 819                   ;; imap clients! we correct this
 820                   seen (append seen (imap-search "SEEN"))
 821                   ;; remove dupes
 822                   seen (sort seen '<)
 823                   seen (gnus-compress-sequence seen t)
 824                   ;; we can't return '(1) since this isn't a "list of ranges",
 825                   ;; and we can't return '((1)) since g-list-of-unread-articles
 826                   ;; is buggy so we return '((1 . 1)).
 827                   seen (if (and (integerp (car seen))
 828                                 (null (cdr seen)))
 829                            (list (cons (car seen) (car seen)))
 830                          seen))
 831             (gnus-info-set-read info seen)))
 832
 833         (mapcar (lambda (pred)
 834                   (when (and (nnimap-mark-permanent-p (cdr pred))
 835                              (member (nnimap-mark-to-flag (cdr pred))
 836                                      (imap-mailbox-get 'flags)))
 837                     (gnus-info-set-marks
 838                      info
 839                      (nnimap-update-alist-soft
 840                       (cdr pred)
 841                       (gnus-compress-sequence
 842                        (imap-search (nnimap-mark-to-predicate (cdr pred))))
 843                       (gnus-info-marks info))
 844                      t)))
 845                 gnus-article-mark-lists)
 846
 847         (gnus-message 5 "nnimap: Updating info for %s...done"
 848                       (gnus-info-group info))
 849
 850         info))))
 851
 852 (deffoo nnimap-request-type (group &optional article)
 853   (if (and nnimap-news-groups (string-match nnimap-news-groups group))
 854       'news
 855     'mail))
 856
 857 (deffoo nnimap-request-set-mark (group actions &optional server)
 858   (when (nnimap-possibly-change-group group server)
 859     (with-current-buffer nnimap-server-buffer
 860       (let (action)
 861         (gnus-message 7 "nnimap: Setting marks in %s..." group)
 862         (while (setq action (pop actions))
 863           (let ((range (nth 0 action))
 864                 (what  (nth 1 action))
 865                 (cmdmarks (nth 2 action))
 866                 marks)
 867             ;; cache flags are pointless on the server
 868             (setq cmdmarks (delq 'cache cmdmarks))
 869             ;; flag dormant articles as ticked
 870             (if (memq 'dormant cmdmarks)
 871                 (setq cmdmarks (cons 'tick cmdmarks)))
 872             ;; remove stuff we are forbidden to store
 873             (mapcar (lambda (mark)
 874                       (if (imap-message-flag-permanent-p
 875                            (nnimap-mark-to-flag mark))
 876                           (setq marks (cons mark marks))))
 877                     cmdmarks)
 878             (when (and range marks)
 879               (cond ((eq what 'del)
 880                      (imap-message-flags-del
 881                       (imap-range-to-message-set range)
 882                       (nnimap-mark-to-flag marks nil t)))
 883                     ((eq what 'add)
 884                      (imap-message-flags-add
 885                       (imap-range-to-message-set range)
 886                       (nnimap-mark-to-flag marks nil t)))
 887                     ((eq what 'set)
 888                      (imap-message-flags-set
 889                       (imap-range-to-message-set range)
 890                       (nnimap-mark-to-flag marks nil t)))))))
 891         (gnus-message 7 "nnimap: Setting marks in %s...done" group))))
 892   nil)
 893
 894 (defun nnimap-split-fancy ()
 895   "Like nnmail-split-fancy, but uses nnimap-split-fancy."
 896   (let ((nnmail-split-fancy nnimap-split-fancy))
 897     (nnmail-split-fancy)))
 898
 899 (defun nnimap-split-to-groups (rules)
 900   ;; tries to match all rules in nnimap-split-rule against content of
 901   ;; nntp-server-buffer, returns a list of groups that matched.
 902   (with-current-buffer nntp-server-buffer
 903     ;; Fold continuation lines.
 904     (goto-char (point-min))
 905     (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
 906       (replace-match " " t t))
 907     (if (functionp rules)
 908         (funcall rules)
 909       (let (to-groups regrepp)
 910         (catch 'split-done
 911           (dolist (rule rules to-groups)
 912             (let ((group (car rule))
 913                   (regexp (cadr rule)))
 914               (goto-char (point-min))
 915               (when (and (if (stringp regexp)
 916                              (progn
 917                                (setq regrepp (string-match "\\\\[0-9&]" group))
 918                                (re-search-forward regexp nil t))
 919                            (funcall regexp group))
 920                          ;; Don't enter the article into the same group twice.
 921                          (not (assoc group to-groups)))
 922                 (push (if regrepp
 923                           (nnmail-expand-newtext group)
 924                         group)
 925                       to-groups)
 926                 (or nnimap-split-crosspost
 927                     (throw 'split-done to-groups))))))))))
 928
 929 (defun nnimap-assoc-match (key alist)
 930   (let (element)
 931     (while (and alist (not element))
 932       (if (string-match (car (car alist)) key)
 933           (setq element (car alist)))
 934       (setq alist (cdr alist)))
 935     element))
 936
 937 (defun nnimap-split-find-rule (server inbox)
 938   (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule))
 939            (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule)))
 940       ;; extended format
 941       (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match
 942                                             server nnimap-split-rule))))
 943     nnimap-split-rule))
 944
 945 (defun nnimap-split-find-inbox (server)
 946   (if (listp nnimap-split-inbox)
 947       nnimap-split-inbox
 948     (list nnimap-split-inbox)))
 949
 950 (defun nnimap-split-articles (&optional group server)
 951   (when (nnimap-possibly-change-server server)
 952     (with-current-buffer nnimap-server-buffer
 953       (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server)))
 954         ;; iterate over inboxes
 955         (while (and (setq inbox (pop inboxes))
 956                     (nnimap-possibly-change-group inbox));; SELECT
 957           ;; find split rule for this server / inbox
 958           (when (setq rule (nnimap-split-find-rule server inbox))
 959             ;; iterate over articles
 960             (dolist (article (imap-search nnimap-split-predicate))
 961               (when (nnimap-request-head article)
 962                 ;; copy article to right group(s)
 963                 (setq removeorig nil)
 964                 (dolist (to-group (nnimap-split-to-groups rule))
 965                   (if (imap-message-copy (number-to-string article)
 966                                          to-group nil 'nocopyuid)
 967                       (progn
 968                         (message "IMAP split moved %s:%s:%d to %s" server inbox
 969                                  article to-group)
 970                         (setq removeorig t)
 971                         ;; Add the group-art list to the history list.
 972                         (push (list (cons to-group 0)) nnmail-split-history))
 973                     (message "IMAP split failed to move %s:%s:%d to %s" server
 974                              inbox article to-group)))
 975                 ;; remove article if it was successfully copied somewhere
 976                 (and removeorig
 977                      (imap-message-flags-add (format "%d" article)
 978                                              "\\Seen \\Deleted")))))
 979           (when (imap-mailbox-select inbox);; just in case
 980             ;; todo: UID EXPUNGE (if available) to remove splitted articles
 981             (imap-mailbox-expunge)
 982             (imap-mailbox-close)))
 983         t))))
 984
 985 (deffoo nnimap-request-scan (&optional group server)
 986   (nnimap-split-articles group server))
 987
 988 (deffoo nnimap-request-newgroups (date &optional server)
 989   (when (nnimap-possibly-change-server server)
 990     (with-current-buffer nntp-server-buffer
 991       (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
 992                     (if (> (length server) 0) " on " "") server)
 993       (erase-buffer)
 994       (nnimap-before-find-minmax-bugworkaround)
 995       (dolist (pattern (nnimap-pattern-to-list-arguments
 996                         nnimap-list-pattern))
 997         (dolist (mbx (imap-mailbox-lsub "*" (car pattern) nil
 998                                         nnimap-server-buffer))
 999           (or (catch 'found
1000                 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1001                                                    nnimap-server-buffer))
1002                   (if (string= (downcase mailbox) "\\noselect")
1003                       (throw 'found t)))
1004                 nil)
1005               (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1006                 (when info
1007                  (insert (format "\"%s\" %d %d y\n"
1008                                  mbx (or (nth 2 info) 0)
1009                                  (max 1 (or (nth 1 info) 1)))))))))
1010       (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1011                     (if (> (length server) 0) " on " "") server))
1012     t))
1013
1014 (deffoo nnimap-request-create-group (group &optional server args)
1015   (when (nnimap-possibly-change-server server)
1016     (or (imap-mailbox-status group 'uidvalidity nnimap-server-buffer)
1017         (imap-mailbox-create group nnimap-server-buffer))))
1018
1019 (defun nnimap-time-substract (time1 time2)
1020   "Return TIME for TIME1 - TIME2."
1021   (let* ((ms (- (car time1) (car time2)))
1022          (ls (- (nth 1 time1) (nth 1 time2))))
1023     (if (< ls 0)
1024         (list (- ms 1) (+ (expt 2 16) ls))
1025       (list ms ls))))
1026
1027 (defun nnimap-date-days-ago (daysago)
1028   "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1029   (let ((date (format-time-string "%d-%b-%Y"
1030                                   (nnimap-time-substract
1031                                    (current-time)
1032                                    (days-to-time daysago)))))
1033     (if (eq ?0 (string-to-char date))
1034         (substring date 1)
1035       date)))
1036
1037 (defun nnimap-request-expire-articles-progress ()
1038   (gnus-message 5 "nnimap: Marking article %d for deletion..."
1039                 imap-current-message))
1040
1041 ;; Notice that we don't actually delete anything, we just mark them deleted.
1042 (deffoo nnimap-request-expire-articles (articles group &optional server force)
1043   (let ((artseq (gnus-compress-sequence articles)))
1044     (when (and artseq (nnimap-possibly-change-group group server))
1045       (with-current-buffer nnimap-server-buffer
1046         (if force
1047             (and (imap-message-flags-add
1048                   (imap-range-to-message-set artseq) "\\Deleted")
1049                  (setq articles nil))
1050           (let ((days (or (and nnmail-expiry-wait-function
1051                                (funcall nnmail-expiry-wait-function group))
1052                           nnmail-expiry-wait)))
1053             (cond ((eq days 'immediate)
1054                    (and (imap-message-flags-add
1055                          (imap-range-to-message-set artseq) "\\Deleted")
1056                         (setq articles nil)))
1057                   ((numberp days)
1058                    (let ((oldarts (imap-search
1059                                    (format "UID %s NOT SINCE %s"
1060                                            (imap-range-to-message-set artseq)
1061                                            (nnimap-date-days-ago days))))
1062                          (imap-fetch-data-hook
1063                           '(nnimap-request-expire-articles-progress)))
1064                      (and oldarts
1065                           (imap-message-flags-add
1066                            (imap-range-to-message-set
1067                             (gnus-compress-sequence oldarts))
1068                            "\\Deleted")
1069                           (setq articles (gnus-set-difference
1070                                           articles oldarts)))))))))))
1071   ;; return articles not deleted
1072   articles)
1073
1074 (deffoo nnimap-request-move-article (article group server
1075                                              accept-form &optional last)
1076   (when (nnimap-possibly-change-server server)
1077     (save-excursion
1078       (let ((buf (get-buffer-create " *nnimap move*"))
1079             (nnimap-current-move-article article)
1080             (nnimap-current-move-group group)
1081             (nnimap-current-move-server nnimap-current-server)
1082             result)
1083         (and (nnimap-request-article article group server)
1084              (save-excursion
1085                (set-buffer buf)
1086                (buffer-disable-undo (current-buffer))
1087                (insert-buffer-substring nntp-server-buffer)
1088                (setq result (eval accept-form))
1089                (kill-buffer buf)
1090                result)
1091              (nnimap-request-expire-articles (list article) group server t))
1092         result))))
1093
1094 (deffoo nnimap-request-accept-article (group &optional server last)
1095   (when (nnimap-possibly-change-server server)
1096     (let (uid)
1097       (if (setq uid
1098                 (if (string= nnimap-current-server nnimap-current-move-server)
1099                     ;; moving article within same server, speed it up...
1100                     (and (nnimap-possibly-change-group
1101                           nnimap-current-move-group)
1102                          (imap-message-copy (number-to-string
1103                                              nnimap-current-move-article)
1104                                             group 'dontcreate nil
1105                                             nnimap-server-buffer))
1106                   ;; turn into rfc822 format (\r\n eol's)
1107                   (with-current-buffer (current-buffer)
1108                     (goto-char (point-min))
1109                     (while (search-forward "\n" nil t)
1110                       (replace-match "\r\n")))
1111                   ;; this 'or' is for Cyrus server bug
1112                   (or (null (imap-current-mailbox nnimap-server-buffer))
1113                       (imap-mailbox-unselect nnimap-server-buffer))
1114                   (imap-message-append group (current-buffer) nil nil
1115                                        nnimap-server-buffer)))
1116           (cons group (nth 1 uid))
1117         (nnheader-report 'nnimap (imap-error-text nnimap-server-buffer))))))
1118
1119 (deffoo nnimap-request-delete-group (group force &optional server)
1120   (when (nnimap-possibly-change-server server)
1121     (with-current-buffer nnimap-server-buffer
1122       (if force
1123           (or (null (imap-mailbox-status group 'uidvalidity))
1124               (imap-mailbox-delete group))
1125         ;; UNSUBSCRIBE?
1126         t))))
1127
1128 (deffoo nnimap-request-rename-group (group new-name &optional server)
1129   (when (nnimap-possibly-change-server server)
1130     (imap-mailbox-rename group new-name nnimap-server-buffer)))
1131
1132 (defun nnimap-expunge (mailbox server)
1133   (when (nnimap-possibly-change-group mailbox server)
1134     (imap-mailbox-expunge nnimap-server-buffer)))
1135
1136 (defun nnimap-acl-get (mailbox server)
1137   (when (nnimap-possibly-change-server server)
1138     (imap-mailbox-acl-get mailbox nnimap-server-buffer)))
1139
1140 (defun nnimap-acl-edit (mailbox method old-acls new-acls)
1141   (when (nnimap-possibly-change-server (cadr method))
1142     (unless (imap-capability 'ACL nnimap-server-buffer)
1143       (error "Your server does not support ACL editing"))
1144     (with-current-buffer nnimap-server-buffer
1145       ;; delete all removed identifiers
1146       (mapcar (lambda (old-acl)
1147                 (unless (assoc (car old-acl) new-acls)
1148                   (or (imap-mailbox-acl-delete (car old-acl) mailbox)
1149                       (error "Can't delete ACL for %s" (car old-acl)))))
1150               old-acls)
1151       ;; set all changed acl's
1152       (mapcar (lambda (new-acl)
1153                 (let ((new-rights (cdr new-acl))
1154                       (old-rights (cdr (assoc (car new-acl) old-acls))))
1155                   (unless (and old-rights new-rights
1156                                (string= old-rights new-rights))
1157                     (or (imap-mailbox-acl-set (car new-acl) new-rights mailbox)
1158                         (error "Can't set ACL for %s to %s" (car new-acl)
1159                                new-rights)))))
1160               new-acls)
1161       t)))
1162
1163 \f
1164 ;;; Internal functions
1165
1166 ;;
1167 ;; This is confusing.
1168 ;;
1169 ;; mark      => read, tick, draft, reply etc
1170 ;; flag      => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1171 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1172 ;;
1173 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1174 ;; world, but we cheat.  Mark == gnus-article-mark-lists + '(read . read).
1175 ;;
1176
1177 (defconst nnimap-mark-to-predicate-alist
1178   (mapcar
1179    (lambda (pair)                       ; cdr is the mark
1180      (or (assoc (cdr pair)
1181                 '((read . "SEEN")
1182                   (tick . "FLAGGED")
1183                   (draft . "DRAFT")
1184                   (reply . "ANSWERED")))
1185          (cons (cdr pair)
1186                (format "KEYWORD gnus-%s" (symbol-name (cdr pair))))))
1187    (cons '(read . read) gnus-article-mark-lists)))
1188
1189 (defun nnimap-mark-to-predicate (pred)
1190   "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1191 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1192 to be used within a IMAP SEARCH query."
1193   (cdr (assq pred nnimap-mark-to-predicate-alist)))
1194
1195 (defconst nnimap-mark-to-flag-alist
1196   (mapcar
1197    (lambda (pair)
1198      (or (assoc (cdr pair)
1199                 '((read . "\\Seen")
1200                   (tick . "\\Flagged")
1201                   (draft . "\\Draft")
1202                   (reply . "\\Answered")))
1203          (cons (cdr pair)
1204                (format "gnus-%s" (symbol-name (cdr pair))))))
1205    (cons '(read . read) gnus-article-mark-lists)))
1206
1207 (defun nnimap-mark-to-flag-1 (preds)
1208   (if (and (not (null preds)) (listp preds))
1209       (cons (nnimap-mark-to-flag (car preds))
1210             (nnimap-mark-to-flag (cdr preds)))
1211     (cdr (assoc preds nnimap-mark-to-flag-alist))))
1212
1213 (defun nnimap-mark-to-flag (preds &optional always-list make-string)
1214   "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1215 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1216 be used in a STORE FLAGS command."
1217   (let ((result (nnimap-mark-to-flag-1 preds)))
1218     (setq result (if (and (or make-string always-list)
1219                           (not (listp result)))
1220                      (list result)
1221                    result))
1222     (if make-string
1223         (mapconcat (lambda (flag)
1224                      (if (listp flag)
1225                          (mapconcat 'identity flag " ")
1226                        flag))
1227                    result " ")
1228       result)))
1229
1230 (defun nnimap-mark-permanent-p (mark &optional group)
1231   "Return t iff MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1232   (imap-message-flag-permanent-p (nnimap-mark-to-flag mark)))
1233
1234 (defun nnimap-remassoc (key alist)
1235   "Delete by side effect any elements of LIST whose car is `equal' to KEY.
1236 The modified LIST is returned.  If the first member
1237 of LIST has a car that is `equal' to KEY, there is no way to remove it
1238 by side effect; therefore, write `(setq foo (remassoc key foo))' to be
1239 sure of changing the value of `foo'."
1240   (when alist
1241     (if (equal key (caar alist))
1242         (cdr alist)
1243       (setcdr alist (nnimap-remassoc key (cdr alist)))
1244       alist)))
1245
1246 (defun nnimap-update-alist-soft (key value alist)
1247   (if value
1248       (cons (cons key value) (nnimap-remassoc key alist))
1249     (nnimap-remassoc key alist)))
1250
1251 (when nnimap-debug
1252   (require 'trace)
1253   (buffer-disable-undo (get-buffer-create nnimap-debug))
1254   (mapcar (lambda (f) (trace-function-background f nnimap-debug))
1255         '(
1256           nnimap-possibly-change-server
1257           nnimap-verify-uidvalidity
1258           nnimap-find-minmax-uid
1259           nnimap-before-find-minmax-bugworkaround
1260           nnimap-possibly-change-group
1261           ;;nnimap-replace-whitespace
1262           nnimap-retrieve-headers-progress
1263           nnimap-retrieve-which-headers
1264           nnimap-group-overview-filename
1265           nnimap-retrieve-headers-from-file
1266           nnimap-retrieve-headers-from-server
1267           nnimap-retrieve-headers
1268           nnimap-open-connection
1269           nnimap-open-server
1270           nnimap-server-opened
1271           nnimap-close-server
1272           nnimap-request-close
1273           nnimap-status-message
1274           ;;nnimap-demule
1275           nnimap-request-article-part
1276           nnimap-request-article
1277           nnimap-request-head
1278           nnimap-request-body
1279           nnimap-request-group
1280           nnimap-close-group
1281           nnimap-pattern-to-list-arguments
1282           nnimap-request-list
1283           nnimap-request-post
1284           nnimap-retrieve-groups
1285           nnimap-request-update-info-internal
1286           nnimap-request-type
1287           nnimap-request-set-mark
1288           nnimap-split-to-groups
1289           nnimap-split-find-rule
1290           nnimap-split-find-inbox
1291           nnimap-split-articles
1292           nnimap-request-scan
1293           nnimap-request-newgroups
1294           nnimap-request-create-group
1295           nnimap-time-substract
1296           nnimap-date-days-ago
1297           nnimap-request-expire-articles-progress
1298           nnimap-request-expire-articles
1299           nnimap-request-move-article
1300           nnimap-request-accept-article
1301           nnimap-request-delete-group
1302           nnimap-request-rename-group
1303           gnus-group-nnimap-expunge
1304           gnus-group-nnimap-edit-acl
1305           gnus-group-nnimap-edit-acl-done
1306           nnimap-group-mode-hook
1307           nnimap-mark-to-predicate
1308           nnimap-mark-to-flag-1
1309           nnimap-mark-to-flag
1310           nnimap-mark-permanent-p
1311           nnimap-remassoc
1312           nnimap-update-alist-soft
1313           )))
1314
1315 (provide 'nnimap)
1316
1317 ;;; nnimap.el ends here