git.chise.org Git - elisp/gnus.git-/blob - lisp/nnimap.el

   1 ;;; nnimap.el --- imap backend for Gnus
   2
   3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
   4 ;;   2005 Free Software Foundation, Inc.
   5
   6 ;; Author: Simon Josefsson <jas@pdc.kth.se>
   7 ;;         Jim Radford <radford@robby.caltech.edu>
   8 ;; Keywords: mail
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software; you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation; either version 2, or (at your option)
  15 ;; any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  25 ;; Boston, MA 02110-1301, USA.
  26
  27 ;;; Commentary:
  28
  29 ;; Todo, major things:
  30 ;;
  31 ;;   o Fix Gnus to view correct number of unread/total articles in group buffer
  32 ;;   o Fix Gnus to handle leading '.' in group names (fixed?)
  33 ;;   o Finish disconnected mode (moving articles between mailboxes unplugged)
  34 ;;   o Sieve
  35 ;;   o MIME (partial article fetches)
  36 ;;   o Split to other backends, different split rules for different
  37 ;;     servers/inboxes
  38 ;;
  39 ;; Todo, minor things:
  40 ;;
  41 ;;   o Don't require half of Gnus -- backends should be standalone
  42 ;;   o Verify that we don't use IMAP4rev1 specific things (RFC2060 App B)
  43 ;;   o Dont uid fetch 1,* in nnimap-retrive-groups (slow)
  44 ;;   o Split up big fetches (1,* header especially) in smaller chunks
  45 ;;   o What do I do with gnus-newsgroup-*?
  46 ;;   o Tell Gnus about new groups (how can we tell?)
  47 ;;   o Respooling (fix Gnus?) (unnecessary?)
  48 ;;   o Add support for the following: (if applicable)
  49 ;;       request-list-newsgroups, request-regenerate
  50 ;;       list-active-group,
  51 ;;       request-associate-buffer, request-restore-buffer,
  52 ;;   o Do The Right Thing when UIDVALIDITY changes (what's the right thing?)
  53 ;;   o Support RFC2221 (Login referrals)
  54 ;;   o IMAP2BIS compatibility? (RFC2061)
  55 ;;   o ACAP stuff (perhaps a different project, would be nice to ACAPify
  56 ;;     .newsrc.eld)
  57 ;;   o What about Gnus's article editing, can we support it?  NO!
  58 ;;   o Use \Draft to support the draft group??
  59 ;;   o Duplicate suppression
  60 ;;   o Rewrite UID SEARCH UID X as UID FETCH X (UID) for those with slow servers
  61
  62 ;;; Code:
  63
  64 (eval-when-compile (require 'cl))
  65 (require 'imap)
  66
  67 (require 'nnoo)
  68 (require 'nnmail)
  69 (require 'nnheader)
  70 (require 'gnus)
  71 (require 'gnus-range)
  72 (require 'gnus-start)
  73 (require 'gnus-int)
  74
  75 (eval-when-compile (require 'cl))
  76
  77 (nnoo-declare nnimap)
  78
  79 (defconst nnimap-version "nnimap 1.0")
  80
  81 (defgroup nnimap nil
  82   "Reading IMAP mail with Gnus."
  83   :group 'gnus)
  84
  85 (defvoo nnimap-address nil
  86   "Address of physical IMAP server.  If nil, use the virtual server's name.")
  87
  88 (defvoo nnimap-server-port nil
  89   "Port number on physical IMAP server.
  90 If nil, defaults to 993 for TLS/SSL connections and 143 otherwise.")
  91
  92 ;; Splitting variables
  93
  94 (defcustom nnimap-split-crosspost t
  95   "If non-nil, do crossposting if several split methods match the mail.
  96 If nil, the first match found will be used."
  97   :group 'nnimap
  98   :type 'boolean)
  99
 100 (defcustom nnimap-split-inbox nil
 101   "Name of mailbox to split mail from.
 102
 103 Mail is read from this mailbox and split according to rules in
 104 `nnimap-split-rule'.
 105
 106 This can be a string or a list of strings."
 107   :group 'nnimap
 108   :type '(choice (string)
 109                  (repeat string)))
 110
 111 (define-widget 'nnimap-strict-function 'function
 112   "This widget only matches values that are functionp.
 113
 114 Warning: This means that a value that is the symbol of a not yet
 115 loaded function will not match.  Use with care."
 116   :match 'nnimap-strict-function-match)
 117
 118 (defun nnimap-strict-function-match (widget value)
 119   "Ignoring WIDGET, match if VALUE is a function."
 120   (functionp value))
 121
 122 (defcustom nnimap-split-rule nil
 123   "Mail will be split according to these rules.
 124
 125 Mail is read from mailbox(es) specified in `nnimap-split-inbox'.
 126
 127 If you'd like, for instance, one mail group for mail from the
 128 \"gnus-imap\" mailing list, one group for junk mail and leave
 129 everything else in the incoming mailbox, you could do something like
 130 this:
 131
 132 \(setq nnimap-split-rule '((\"INBOX.gnus-imap\"   \"From:.*gnus-imap\")
 133                           (\"INBOX.junk\"        \"Subject:.*buy\")))
 134
 135 As you can see, `nnimap-split-rule' is a list of lists, where the
 136 first element in each \"rule\" is the name of the IMAP mailbox (or the
 137 symbol `junk' if you want to remove the mail), and the second is a
 138 regexp that nnimap will try to match on the header to find a fit.
 139
 140 The second element can also be a function.  In that case, it will be
 141 called narrowed to the headers with the first element of the rule as
 142 the argument.  It should return a non-nil value if it thinks that the
 143 mail belongs in that group.
 144
 145 This variable can also have a function as its value, the function will
 146 be called with the headers narrowed and should return a group where it
 147 thinks the article should be splitted to.  See `nnimap-split-fancy'.
 148
 149 To allow for different split rules on different virtual servers, and
 150 even different split rules in different inboxes on the same server,
 151 the syntax of this variable have been extended along the lines of:
 152
 153 \(setq nnimap-split-rule
 154       '((\"my1server\"    (\".*\"    ((\"ding\"    \"ding@gnus.org\")
 155                                   (\"junk\"    \"From:.*Simon\")))
 156         (\"my2server\"    (\"INBOX\" nnimap-split-fancy))
 157         (\"my[34]server\" (\".*\"    ((\"private\" \"To:.*Simon\")
 158                                   (\"junk\"    my-junk-func)))))
 159
 160 The virtual server name is in fact a regexp, so that the same rules
 161 may apply to several servers.  In the example, the servers
 162 \"my3server\" and \"my4server\" both use the same rules.  Similarly,
 163 the inbox string is also a regexp.  The actual splitting rules are as
 164 before, either a function, or a list with group/regexp or
 165 group/function elements."
 166   :group 'nnimap
 167   :type '(choice :tag "Rule type"
 168                  (repeat :menu-tag "Single-server"
 169                          :tag "Single-server list"
 170                          (list (string :tag "Mailbox")
 171                                (choice :tag "Predicate"
 172                                        (regexp :tag "A regexp")
 173                                        (nnimap-strict-function :tag "A function"))))
 174                  (choice :menu-tag "A function"
 175                          :tag "A function"
 176                          (function-item nnimap-split-fancy)
 177                          (function-item nnmail-split-fancy)
 178                          (nnimap-strict-function :tag "User-defined function"))
 179                  (repeat :menu-tag "Multi-server (extended)"
 180                          :tag "Multi-server list"
 181                          (list (regexp :tag "Server regexp")
 182                                (list (regexp :tag "Incoming Mailbox regexp")
 183                                      (repeat :tag "Rules for matching server(s) and mailbox(es)"
 184                                              (list (string :tag "Destination mailbox")
 185                                                    (choice :tag "Predicate"
 186                                                            (regexp :tag "A Regexp")
 187                                                            (nnimap-strict-function :tag "A Function")))))))))
 188
 189 (defcustom nnimap-split-predicate "UNSEEN UNDELETED"
 190   "The predicate used to find articles to split.
 191 If you use another IMAP client to peek on articles but always would
 192 like nnimap to split them once it's started, you could change this to
 193 \"UNDELETED\". Other available predicates are available in
 194 RFC2060 section 6.4.4."
 195   :group 'nnimap
 196   :type 'string)
 197
 198 (defcustom nnimap-split-fancy nil
 199   "Like the variable `nnmail-split-fancy'."
 200   :group 'nnimap
 201   :type 'sexp)
 202
 203 (defvar nnimap-split-download-body-default nil
 204   "Internal variable with default value for `nnimap-split-download-body'.")
 205
 206 (defcustom nnimap-split-download-body 'default
 207   "Whether to download entire articles during splitting.
 208 This is generally not required, and will slow things down considerably.
 209 You may need it if you want to use an advanced splitting function that
 210 analyzes the body before splitting the article.
 211 If this variable is nil, bodies will not be downloaded; if this
 212 variable is the symbol `default' the default behaviour is
 213 used (which currently is nil, unless you use a statistical
 214 spam.el test); if this variable is another non-nil value bodies
 215 will be downloaded."
 216   :version "22.1"
 217   :group 'nnimap
 218   :type '(choice (const :tag "Let system decide" deault)
 219                  boolean))
 220
 221 ;; Performance / bug workaround variables
 222
 223 (defcustom nnimap-close-asynchronous t
 224   "Close mailboxes asynchronously in `nnimap-close-group'.
 225 This means that errors caught by nnimap when closing the mailbox will
 226 not prevent Gnus from updating the group status, which may be harmful.
 227 However, it increases speed."
 228   :version "22.1"
 229   :type 'boolean
 230   :group 'nnimap)
 231
 232 (defcustom nnimap-dont-close t
 233   "Never close mailboxes.
 234 This increases the speed of closing mailboxes (quiting group) but may
 235 decrease the speed of selecting another mailbox later.  Re-selecting
 236 the same mailbox will be faster though."
 237   :version "22.1"
 238   :type 'boolean
 239   :group 'nnimap)
 240
 241 (defcustom nnimap-retrieve-groups-asynchronous t
 242   "Send asynchronous STATUS commands for each mailbox before checking mail.
 243 If you have mailboxes that rarely receives mail, this speeds up new
 244 mail checking.  It works by first sending STATUS commands for each
 245 mailbox, and then only checking groups which has a modified UIDNEXT
 246 more carefully for new mail.
 247
 248 In summary, the default is O((1-p)*k+p*n) and changing it to nil makes
 249 it O(n).  If p is small, then the default is probably faster."
 250   :version "22.1"
 251   :type 'boolean
 252   :group 'nnimap)
 253
 254 (defvoo nnimap-need-unselect-to-notice-new-mail nil
 255   "Unselect mailboxes before looking for new mail in them.
 256 Some servers seem to need this under some circumstances.")
 257
 258 ;; Authorization / Privacy variables
 259
 260 (defvoo nnimap-auth-method nil
 261   "Obsolete.")
 262
 263 (defvoo nnimap-stream nil
 264   "How nnimap will connect to the server.
 265
 266 The default, nil, will try to use the \"best\" method the server can
 267 handle.
 268
 269 Change this if
 270
 271 1) you want to connect with TLS/SSL.  The TLS/SSL integration
 272    with IMAP is suboptimal so you'll have to tell it
 273    specifically.
 274
 275 2) your server is more capable than your environment -- i.e. your
 276    server accept Kerberos login's but you haven't installed the
 277    `imtest' program or your machine isn't configured for Kerberos.
 278
 279 Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell.
 280 See also `imap-streams' and `imap-stream-alist'.")
 281
 282 (defvoo nnimap-authenticator nil
 283   "How nnimap authenticate itself to the server.
 284
 285 The default, nil, will try to use the \"best\" method the server can
 286 handle.
 287
 288 There is only one reason for fiddling with this variable, and that is
 289 if your server is more capable than your environment -- i.e. you
 290 connect to a server that accept Kerberos login's but you haven't
 291 installed the `imtest' program or your machine isn't configured for
 292 Kerberos.
 293
 294 Possible choices: gssapi, kerberos4, digest-md5, cram-md5, login, anonymous.
 295 See also `imap-authenticators' and `imap-authenticator-alist'")
 296
 297 (defvoo nnimap-directory (nnheader-concat gnus-directory "overview/")
 298   "Directory to keep NOV cache files for nnimap groups.
 299 See also `nnimap-nov-file-name'.")
 300
 301 (defvoo nnimap-nov-file-name "nnimap."
 302   "NOV cache base filename.
 303 The group name and `nnimap-nov-file-name-suffix' will be appended.  A
 304 typical complete file name would be
 305 ~/News/overview/nnimap.pdc.INBOX.ding.nov, or
 306 ~/News/overview/nnimap/pdc/INBOX/ding/nov if
 307 `nnmail-use-long-file-names' is nil")
 308
 309 (defvoo nnimap-nov-file-name-suffix ".novcache"
 310   "Suffix for NOV cache base filename.")
 311
 312 (defvoo nnimap-nov-is-evil gnus-agent
 313   "If non-nil, never generate or use a local nov database for this backend.
 314 Using nov databases should speed up header fetching considerably.
 315 However, it will invoke a UID SEARCH UID command on the server, and
 316 some servers implement this command inefficiently by opening each and
 317 every message in the group, thus making it quite slow.
 318 Unlike other backends, you do not need to take special care if you
 319 flip this variable.")
 320
 321 (defvoo nnimap-expunge-on-close 'always ; 'ask, 'never
 322   "Whether to expunge a group when it is closed.
 323 When a IMAP group with articles marked for deletion is closed, this
 324 variable determine if nnimap should actually remove the articles or
 325 not.
 326
 327 If always, nnimap always perform a expunge when closing the group.
 328 If never, nnimap never expunges articles marked for deletion.
 329 If ask, nnimap will ask you if you wish to expunge marked articles.
 330
 331 When setting this variable to `never', you can only expunge articles
 332 by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")
 333
 334 (defvoo nnimap-list-pattern "*"
 335   "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
 336 See below for available wildcards.
 337
 338 The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
 339 REFERENCE will be passed as the first parameter to LIST/LSUB.  The
 340 semantics of this are server specific, on the University of Washington
 341 server you can specify a directory.
 342
 343 Example:
 344  '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))
 345
 346 There are two wildcards * and %. * matches everything, % matches
 347 everything in the current hierarchy.")
 348
 349 (defvoo nnimap-news-groups nil
 350   "IMAP support a news-like mode, also known as bulletin board mode,
 351 where replies is sent via IMAP instead of SMTP.
 352
 353 This variable should contain a regexp matching groups where you wish
 354 replies to be stored to the mailbox directly.
 355
 356 Example:
 357   '(\"^[^I][^N][^B][^O][^X].*$\")
 358
 359 This will match all groups not beginning with \"INBOX\".
 360
 361 Note that there is nothing technically different between mail-like and
 362 news-like mailboxes.  If you wish to have a group with todo items or
 363 similar which you wouldn't want to set up a mailing list for, you can
 364 use this to make replies go directly to the group.")
 365
 366 (defvoo nnimap-expunge-search-string "UID %s NOT SINCE %s"
 367   "IMAP search command to use for articles that are to be expired.
 368 The first %s is replaced by a UID set of articles to search on,
 369 and the second %s is replaced by a date criterium.
 370
 371 One useful (and perhaps the only useful) value to change this to would
 372 be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header
 373 instead of the internal date of messages.  See section 6.4.4 of RFC
 374 2060 for more information on valid strings.")
 375
 376 (defvoo nnimap-importantize-dormant t
 377   "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients.
 378 Note that within Gnus, dormant articles will still (only) be
 379 marked as ticked.  This is to make \"dormant\" articles stand out,
 380 just like \"ticked\" articles, in other IMAP clients.")
 381
 382 (defvoo nnimap-server-address nil
 383   "Obsolete.  Use `nnimap-address'.")
 384
 385 (defcustom nnimap-authinfo-file "~/.authinfo"
 386   "Authorization information for IMAP servers.  In .netrc format."
 387   :type
 388   '(choice file
 389            (repeat :tag "Entries"
 390                    :menu-tag "Inline"
 391                    (list :format "%v"
 392                          :value ("" ("login" . "") ("password" . ""))
 393                          (string :tag "Host")
 394                          (checklist :inline t
 395                                     (cons :format "%v"
 396                                           (const :format "" "login")
 397                                           (string :format "Login: %v"))
 398                                     (cons :format "%v"
 399                                           (const :format "" "password")
 400                                           (string :format "Password: %v"))))))
 401   :group 'nnimap)
 402
 403 (defcustom nnimap-prune-cache t
 404   "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
 405   :type 'boolean
 406   :group 'nnimap)
 407
 408 (defvar nnimap-request-list-method 'imap-mailbox-list
 409   "Method to use to request a list of all folders from the server.
 410 If this is 'imap-mailbox-lsub, then use a server-side subscription list to
 411 restrict visible folders.")
 412
 413 (defcustom nnimap-id nil
 414   "Plist with client identity to send to server upon login.
 415 Nil means no information is sent, symbol `no' to disable ID query
 416 alltogheter, or plist with identifier-value pairs to send to
 417 server.  RFC 2971 describes the list as follows:
 418
 419    Any string may be sent as a field, but the following are defined to
 420    describe certain values that might be sent.  Implementations are free
 421    to send none, any, or all of these.  Strings are not case-sensitive.
 422    Field strings MUST NOT be longer than 30 octets.  Value strings MUST
 423    NOT be longer than 1024 octets.  Implementations MUST NOT send more
 424    than 30 field-value pairs.
 425
 426      name            Name of the program
 427      version         Version number of the program
 428      os              Name of the operating system
 429      os-version      Version of the operating system
 430      vendor          Vendor of the client/server
 431      support-url     URL to contact for support
 432      address         Postal address of contact/vendor
 433      date            Date program was released, specified as a date-time
 434                        in IMAP4rev1
 435      command         Command used to start the program
 436      arguments       Arguments supplied on the command line, if any
 437                        if any
 438      environment     Description of environment, i.e., UNIX environment
 439                        variables or Windows registry settings
 440
 441    Implementations MUST NOT send the same field name more than once.
 442
 443 An example plist would be '(\"name\" \"Gnus\" \"version\" gnus-version-number
 444 \"os\" system-configuration \"vendor\" \"GNU\")."
 445   :group 'nnimap
 446   :type '(choice (const :tag "No information" nil)
 447                  (const :tag "Disable ID query" no)
 448                  (plist :key-type string :value-type string)))
 449
 450 (defcustom nnimap-debug nil
 451   "If non-nil, random debug spews are placed in *nnimap-debug* buffer.
 452 Note that username, passwords and other privacy sensitive
 453 information (such as e-mail) may be stored in the *nnimap-debug*
 454 buffer.  It is not written to disk, however.  Do not enable this
 455 variable unless you are comfortable with that."
 456   :group 'nnimap
 457   :type 'boolean)
 458
 459 ;; Internal variables:
 460
 461 (defvar nnimap-debug-buffer "*nnimap-debug*")
 462 (defvar nnimap-mailbox-info (gnus-make-hashtable 997))
 463 (defvar nnimap-current-move-server nil)
 464 (defvar nnimap-current-move-group nil)
 465 (defvar nnimap-current-move-article nil)
 466 (defvar nnimap-length)
 467 (defvar nnimap-progress-chars '(?| ?/ ?- ?\\))
 468 (defvar nnimap-progress-how-often 20)
 469 (defvar nnimap-counter)
 470 (defvar nnimap-server-buffer-alist nil) ;; Map server name to buffers.
 471 (defvar nnimap-current-server nil)      ;; Current server
 472 (defvar nnimap-server-buffer nil)       ;; Current servers' buffer
 473
 474 \f
 475
 476 (nnoo-define-basics nnimap)
 477
 478 ;; Utility functions:
 479
 480 (defsubst nnimap-get-server-buffer (server)
 481   "Return buffer for SERVER, if nil use current server."
 482   (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist)))
 483
 484 (defun nnimap-remove-server-from-buffer-alist (server list)
 485   "Remove SERVER from LIST."
 486   (let (l)
 487     (dolist (e list)
 488       (unless (equal server (car-safe e))
 489         (push e l)))
 490     l))
 491
 492 (defun nnimap-possibly-change-server (server)
 493   "Return buffer for SERVER, changing the current server as a side-effect.
 494 If SERVER is nil, uses the current server."
 495   (setq nnimap-current-server (or server nnimap-current-server)
 496         nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server)))
 497
 498 (defun nnimap-verify-uidvalidity (group server)
 499   "Verify stored uidvalidity match current one in GROUP on SERVER."
 500   (let* ((gnusgroup (gnus-group-prefixed-name
 501                      group (gnus-server-to-method
 502                             (format "nnimap:%s" server))))
 503          (new-uidvalidity (imap-mailbox-get 'uidvalidity))
 504          (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity))
 505          (dir (file-name-as-directory (expand-file-name nnimap-directory)))
 506          (nameuid (nnheader-translate-file-chars
 507                    (concat nnimap-nov-file-name
 508                            (if (equal server "")
 509                                "unnamed"
 510                              server) "." group "." old-uidvalidity
 511                              nnimap-nov-file-name-suffix) t))
 512          (file (if (or nnmail-use-long-file-names
 513                        (file-exists-p (expand-file-name nameuid dir)))
 514                    (expand-file-name nameuid dir)
 515                  (expand-file-name
 516                   (encode-coding-string
 517                    (nnheader-replace-chars-in-string nameuid ?. ?/)
 518                    nnmail-pathname-coding-system)
 519                   dir))))
 520     (if old-uidvalidity
 521         (if (not (equal old-uidvalidity new-uidvalidity))
 522             ;; uidvalidity clash
 523             (gnus-delete-file file)
 524           (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
 525           t)
 526       (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
 527       t)))
 528
 529 (defun nnimap-before-find-minmax-bugworkaround ()
 530   "Function called before iterating through mailboxes with
 531 `nnimap-find-minmax-uid'."
 532   (when nnimap-need-unselect-to-notice-new-mail
 533     ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
 534     ;; currently selected mailbox without a re-select/examine.
 535     (or (null (imap-current-mailbox nnimap-server-buffer))
 536         (imap-mailbox-unselect nnimap-server-buffer))))
 537
 538 (defun nnimap-find-minmax-uid (group &optional examine)
 539   "Find lowest and highest active article number in GROUP.
 540 If EXAMINE is non-nil the group is selected read-only."
 541   (with-current-buffer nnimap-server-buffer
 542     (when (or (string= group (imap-current-mailbox))
 543               (imap-mailbox-select group examine))
 544       (let (minuid maxuid)
 545         (when (> (imap-mailbox-get 'exists) 0)
 546           (imap-fetch "1,*" "UID" nil 'nouidfetch)
 547           (imap-message-map (lambda (uid Uid)
 548                               (setq minuid (if minuid (min minuid uid) uid)
 549                                     maxuid (if maxuid (max maxuid uid) uid)))
 550                             'UID))
 551         (list (imap-mailbox-get 'exists) minuid maxuid)))))
 552
 553 (defun nnimap-possibly-change-group (group &optional server)
 554   "Make GROUP the current group, and SERVER the current server."
 555   (when (nnimap-possibly-change-server server)
 556     (with-current-buffer nnimap-server-buffer
 557       (if (or (null group) (imap-current-mailbox-p group))
 558           imap-current-mailbox
 559         (if (imap-mailbox-select group)
 560             (if (or (nnimap-verify-uidvalidity
 561                      group (or server nnimap-current-server))
 562                     (zerop (imap-mailbox-get 'exists group))
 563                     t ;; for OGnus to see if ignoring uidvalidity
 564                       ;; changes has any bad effects.
 565                     (yes-or-no-p
 566                      (format
 567                       "nnimap: Group %s is not uidvalid.  Continue? " group)))
 568                 imap-current-mailbox
 569               (imap-mailbox-unselect)
 570               (error "nnimap: Group %s is not uid-valid" group))
 571           (nnheader-report 'nnimap (imap-error-text)))))))
 572
 573 (defun nnimap-replace-whitespace (string)
 574   "Return STRING with all whitespace replaced with space."
 575   (when string
 576     (while (string-match "[\r\n\t]+" string)
 577       (setq string (replace-match " " t t string)))
 578     string))
 579
 580 ;; Required backend functions
 581
 582 (defun nnimap-retrieve-headers-progress ()
 583   "Hook to insert NOV line for current article into `nntp-server-buffer'."
 584   (and (numberp nnmail-large-newsgroup)
 585        (zerop (% (incf nnimap-counter) nnimap-progress-how-often))
 586        (> nnimap-length nnmail-large-newsgroup)
 587        (nnheader-message 6 "nnimap: Retrieving headers... %c"
 588                          (nth (/ (% nnimap-counter
 589                                     (* (length nnimap-progress-chars)
 590                                        nnimap-progress-how-often))
 591                                  nnimap-progress-how-often)
 592                               nnimap-progress-chars)))
 593   (with-current-buffer nntp-server-buffer
 594     (let (headers lines chars uid mbx)
 595       (with-current-buffer nnimap-server-buffer
 596         (setq uid imap-current-message
 597               mbx imap-current-mailbox
 598               headers (nnimap-demule
 599                        (if (imap-capability 'IMAP4rev1)
 600                            ;; xxx don't just use car? alist doesn't contain
 601                            ;; anything else now, but it might...
 602                            (nth 2 (car (imap-message-get uid 'BODYDETAIL)))
 603                          (imap-message-get uid 'RFC822.HEADER)))
 604               lines (imap-body-lines (imap-message-body imap-current-message))
 605               chars (imap-message-get imap-current-message 'RFC822.SIZE)))
 606       (nnheader-insert-nov
 607        (with-temp-buffer
 608          (buffer-disable-undo)
 609          (insert headers)
 610          (let ((head (nnheader-parse-naked-head uid)))
 611            (mail-header-set-number head uid)
 612            (mail-header-set-chars head chars)
 613            (mail-header-set-lines head lines)
 614            (mail-header-set-xref
 615             head (format "%s %s:%d" (system-name) mbx uid))
 616            head))))))
 617
 618 (defun nnimap-retrieve-which-headers (articles fetch-old)
 619   "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
 620   (with-current-buffer nnimap-server-buffer
 621     (if (numberp (car-safe articles))
 622         (imap-search
 623          (concat "UID "
 624                  (imap-range-to-message-set
 625                   (gnus-compress-sequence
 626                    (append (gnus-uncompress-sequence
 627                             (and fetch-old
 628                                  (cons (if (numberp fetch-old)
 629                                            (max 1 (- (car articles) fetch-old))
 630                                          1)
 631                                        (1- (car articles)))))
 632                            articles)))))
 633       (mapcar (lambda (msgid)
 634                 (imap-search
 635                  (format "HEADER Message-Id \"%s\"" msgid)))
 636               articles))))
 637
 638 (defun nnimap-group-overview-filename (group server)
 639   "Make file name for GROUP on SERVER."
 640   (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
 641          (uidvalidity (gnus-group-get-parameter
 642                        (gnus-group-prefixed-name
 643                         group (gnus-server-to-method
 644                                (format "nnimap:%s" server)))
 645                        'uidvalidity))
 646          (name (nnheader-translate-file-chars
 647                 (concat nnimap-nov-file-name
 648                         (if (equal server "")
 649                             "unnamed"
 650                           server) "." group nnimap-nov-file-name-suffix) t))
 651          (nameuid (nnheader-translate-file-chars
 652                    (concat nnimap-nov-file-name
 653                            (if (equal server "")
 654                                "unnamed"
 655                              server) "." group "." uidvalidity
 656                              nnimap-nov-file-name-suffix) t))
 657          (oldfile (if (or nnmail-use-long-file-names
 658                           (file-exists-p (expand-file-name name dir)))
 659                       (expand-file-name name dir)
 660                     (expand-file-name
 661                      (encode-coding-string
 662                       (nnheader-replace-chars-in-string name ?. ?/)
 663                       nnmail-pathname-coding-system)
 664                      dir)))
 665          (newfile (if (or nnmail-use-long-file-names
 666                           (file-exists-p (expand-file-name nameuid dir)))
 667                       (expand-file-name nameuid dir)
 668                     (expand-file-name
 669                      (encode-coding-string
 670                       (nnheader-replace-chars-in-string nameuid ?. ?/)
 671                       nnmail-pathname-coding-system)
 672                      dir))))
 673     (when (and (file-exists-p oldfile) (not (file-exists-p newfile)))
 674       (message "nnimap: Upgrading novcache filename...")
 675       (sit-for 1)
 676       (gnus-make-directory (file-name-directory newfile))
 677       (unless (ignore-errors (rename-file oldfile newfile) t)
 678         (if (ignore-errors (copy-file oldfile newfile) t)
 679             (delete-file oldfile)
 680           (error "Can't rename `%s' to `%s'" oldfile newfile))))
 681     newfile))
 682
 683 (defun nnimap-retrieve-headers-from-file (group server)
 684   (with-current-buffer nntp-server-buffer
 685     (let ((nov (nnimap-group-overview-filename group server)))
 686       (when (file-exists-p nov)
 687         (nnheader-insert-file-contents nov)
 688         (set-buffer-modified-p nil)
 689         (let ((min (ignore-errors (goto-char (point-min))
 690                                   (read (current-buffer))))
 691               (max (ignore-errors (goto-char (point-max))
 692                                   (forward-line -1)
 693                                   (read (current-buffer)))))
 694           (if (and (numberp min) (numberp max))
 695               (cons min max)
 696             ;; junk, remove it, it's saved later
 697             (erase-buffer)
 698             nil))))))
 699
 700 (defun nnimap-retrieve-headers-from-server (articles group server)
 701   (with-current-buffer nnimap-server-buffer
 702     (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
 703           (nnimap-length (gnus-range-length articles))
 704           (nnimap-counter 0))
 705       (imap-fetch (imap-range-to-message-set articles)
 706                   (concat "(UID RFC822.SIZE BODY "
 707                           (let ((headers
 708                                  (append '(Subject From Date Message-Id
 709                                                    References In-Reply-To Xref)
 710                                          (copy-sequence
 711                                           nnmail-extra-headers))))
 712                             (if (imap-capability 'IMAP4rev1)
 713                                 (format "BODY.PEEK[HEADER.FIELDS %s])" headers)
 714                               (format "RFC822.HEADER.LINES %s)" headers)))))
 715       (with-current-buffer nntp-server-buffer
 716         (sort-numeric-fields 1 (point-min) (point-max)))
 717       (and (numberp nnmail-large-newsgroup)
 718            (> nnimap-length nnmail-large-newsgroup)
 719            (nnheader-message 6 "nnimap: Retrieving headers...done")))))
 720
 721 (defun nnimap-dont-use-nov-p (group server)
 722   (or gnus-nov-is-evil nnimap-nov-is-evil
 723       (unless (and (gnus-make-directory
 724                     (file-name-directory
 725                      (nnimap-group-overview-filename group server)))
 726                    (file-writable-p
 727                     (nnimap-group-overview-filename group server)))
 728         (message "nnimap: Nov cache not writable, %s"
 729                  (nnimap-group-overview-filename group server)))))
 730
 731 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
 732   (when (nnimap-possibly-change-group group server)
 733     (with-current-buffer nntp-server-buffer
 734       (erase-buffer)
 735       (if (nnimap-dont-use-nov-p group server)
 736           (nnimap-retrieve-headers-from-server
 737            (gnus-compress-sequence articles) group server)
 738         (let (uids cached low high)
 739           (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
 740                       low (car uids)
 741                       high (car (last uids)))
 742             (if (setq cached (nnimap-retrieve-headers-from-file group server))
 743                 (progn
 744                   ;; fetch articles with uids before cache block
 745                   (when (< low (car cached))
 746                     (goto-char (point-min))
 747                     (nnimap-retrieve-headers-from-server
 748                      (cons low (1- (car cached))) group server))
 749                   ;; fetch articles with uids after cache block
 750                   (when (> high (cdr cached))
 751                     (goto-char (point-max))
 752                     (nnimap-retrieve-headers-from-server
 753                      (cons (1+ (cdr cached)) high) group server))
 754                   (when nnimap-prune-cache
 755                     ;; remove nov's for articles which has expired on server
 756                     (goto-char (point-min))
 757                     (dolist (uid (gnus-set-difference articles uids))
 758                       (when (re-search-forward (format "^%d\t" uid) nil t)
 759                         (gnus-delete-line)))))
 760               ;; nothing cached, fetch whole range from server
 761               (nnimap-retrieve-headers-from-server
 762                (cons low high) group server))
 763             (when (buffer-modified-p)
 764               (nnmail-write-region
 765                (point-min) (point-max)
 766                (nnimap-group-overview-filename group server) nil 'nomesg))
 767             (nnheader-nov-delete-outside-range low high))))
 768       'nov)))
 769
 770 (defun nnimap-open-connection (server)
 771   (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
 772                       nnimap-authenticator nnimap-server-buffer))
 773       (nnheader-report 'nnimap "Can't open connection to server %s" server)
 774     (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
 775                 (imap-capability 'IMAP4rev1 nnimap-server-buffer))
 776       (imap-close nnimap-server-buffer)
 777       (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
 778     (let* ((list (progn (gnus-message 7 "Parsing authinfo file `%s'."
 779                                       nnimap-authinfo-file)
 780                         (netrc-parse nnimap-authinfo-file)))
 781            (port (if nnimap-server-port
 782                      (int-to-string nnimap-server-port)
 783                    "imap"))
 784            (user (netrc-machine-user-or-password
 785                   "login"
 786                   list
 787                   (list server
 788                         (or nnimap-server-address
 789                             nnimap-address))
 790                   (list port)
 791                   (list "imap" "imaps")))
 792            (passwd (netrc-machine-user-or-password
 793                     "password"
 794                     list
 795                     (list server
 796                           (or nnimap-server-address
 797                               nnimap-address))
 798                     (list port)
 799                     (list "imap" "imaps"))))
 800       (if (imap-authenticate user passwd nnimap-server-buffer)
 801           (prog2
 802               (setq nnimap-server-buffer-alist
 803                     (nnimap-remove-server-from-buffer-alist
 804                      server
 805                      nnimap-server-buffer-alist))
 806               (push (list server nnimap-server-buffer)
 807                     nnimap-server-buffer-alist)
 808             (imap-id nnimap-id nnimap-server-buffer)
 809             (nnimap-possibly-change-server server))
 810         (imap-close nnimap-server-buffer)
 811         (kill-buffer nnimap-server-buffer)
 812         (nnheader-report 'nnimap "Could not authenticate to %s" server)))))
 813
 814 (deffoo nnimap-open-server (server &optional defs)
 815   (nnheader-init-server-buffer)
 816   (if (nnimap-server-opened server)
 817       t
 818     (unless (assq 'nnimap-server-buffer defs)
 819       (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
 820     ;; translate `nnimap-server-address' to `nnimap-address' in defs
 821     ;; for people that configured nnimap with a very old version
 822     (unless (assq 'nnimap-address defs)
 823       (if (assq 'nnimap-server-address defs)
 824           (push (list 'nnimap-address
 825                       (cadr (assq 'nnimap-server-address defs))) defs)
 826         (push (list 'nnimap-address server) defs)))
 827     (nnoo-change-server 'nnimap server defs)
 828     (or nnimap-server-buffer
 829         (setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
 830     (with-current-buffer (get-buffer-create nnimap-server-buffer)
 831       (nnoo-change-server 'nnimap server defs))
 832     (or (and nnimap-server-buffer
 833              (imap-opened nnimap-server-buffer)
 834              (if (with-current-buffer nnimap-server-buffer
 835                    (memq imap-state '(auth selected examine)))
 836                  t
 837                (imap-close nnimap-server-buffer)
 838                (nnimap-open-connection server)))
 839         (nnimap-open-connection server))))
 840
 841 (deffoo nnimap-server-opened (&optional server)
 842   "Whether SERVER is opened.
 843 If SERVER is the current virtual server, and the connection to the
 844 physical server is alive, this function return a non-nil value.  If
 845 SERVER is nil, it is treated as the current server."
 846   ;; clean up autologouts??
 847   (and (or server nnimap-current-server)
 848        (nnoo-server-opened 'nnimap (or server nnimap-current-server))
 849        (imap-opened (nnimap-get-server-buffer server))))
 850
 851 (deffoo nnimap-close-server (&optional server)
 852   "Close connection to server and free all resources connected to it.
 853 Return nil if the server couldn't be closed for some reason."
 854   (let ((server (or server nnimap-current-server)))
 855     (when (or (nnimap-server-opened server)
 856               (imap-opened (nnimap-get-server-buffer server)))
 857       (imap-close (nnimap-get-server-buffer server))
 858       (kill-buffer (nnimap-get-server-buffer server))
 859       (setq nnimap-server-buffer nil
 860             nnimap-current-server nil
 861             nnimap-server-buffer-alist
 862             (nnimap-remove-server-from-buffer-alist
 863              server
 864              nnimap-server-buffer-alist)))
 865     (nnoo-close-server 'nnimap server)))
 866
 867 (deffoo nnimap-request-close ()
 868   "Close connection to all servers and free all resources that the backend have reserved.
 869 All buffers that have been created by that
 870 backend should be killed.  (Not the nntp-server-buffer, though.) This
 871 function is generally only called when Gnus is shutting down."
 872   (mapc (lambda (server) (nnimap-close-server (car server)))
 873         nnimap-server-buffer-alist)
 874   (setq nnimap-server-buffer-alist nil))
 875
 876 (deffoo nnimap-status-message (&optional server)
 877   "This function returns the last error message from server."
 878   (when (nnimap-possibly-change-server server)
 879     (nnoo-status-message 'nnimap server)))
 880
 881 (defun nnimap-demule (string)
 882   ;; BEWARE: we used to use string-as-multibyte here which is braindead
 883   ;; because it will turn accidental emacs-mule-valid byte sequences
 884   ;; into multibyte chars.  --Stef
 885   ;; Reverted, braindead got 7.5 out of 10 on imdb, so it can't be
 886   ;; that bad. --Simon
 887   (funcall (if (and (fboundp 'string-as-multibyte)
 888                     (subrp (symbol-function 'string-as-multibyte)))
 889                'string-as-multibyte
 890              'identity)
 891            (or string "")))
 892
 893 (defun nnimap-make-callback (article gnus-callback buffer)
 894   "Return a callback function."
 895   `(lambda ()
 896      (nnimap-callback ,article ,gnus-callback ,buffer)))
 897
 898 (defun nnimap-callback (article gnus-callback buffer)
 899   (when (eq article (imap-current-message))
 900     (remove-hook 'imap-fetch-data-hook
 901                  (nnimap-make-callback article gnus-callback buffer))
 902     (with-current-buffer buffer
 903       (insert
 904        (with-current-buffer nnimap-server-buffer
 905          (nnimap-demule
 906           (if (imap-capability 'IMAP4rev1)
 907               ;; xxx don't just use car? alist doesn't contain
 908               ;; anything else now, but it might...
 909               (nth 2 (car (imap-message-get article 'BODYDETAIL)))
 910             (imap-message-get article 'RFC822)))))
 911       (nnheader-ms-strip-cr)
 912       (funcall gnus-callback t))))
 913
 914 (defun nnimap-request-article-part (article part prop &optional
 915                                             group server to-buffer detail)
 916   (when (nnimap-possibly-change-group group server)
 917     (let ((article (if (stringp article)
 918                        (car-safe (imap-search
 919                                   (format "HEADER Message-Id \"%s\"" article)
 920                                   nnimap-server-buffer))
 921                      article)))
 922       (when article
 923         (gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
 924                       article (or group imap-current-mailbox
 925                                   gnus-newsgroup-name))
 926         (if (not nnheader-callback-function)
 927             (with-current-buffer (or to-buffer nntp-server-buffer)
 928               (erase-buffer)
 929               (let ((data (imap-fetch article part prop nil
 930                                       nnimap-server-buffer)))
 931                 (when data
 932                   (insert (nnimap-demule (if detail (nth 2 (car data)) data)))
 933                   (nnheader-ms-strip-cr)
 934                   (gnus-message
 935                    10 "nnimap: Fetching (part of) article %d from %s...done"
 936                    article (or group imap-current-mailbox gnus-newsgroup-name))
 937                   (if (bobp)
 938                       (nnheader-report 'nnimap "No such article %d in %s: %s"
 939                                        article (or group imap-current-mailbox
 940                                                    gnus-newsgroup-name)
 941                                        (imap-error-text nnimap-server-buffer))
 942                     (cons group article)))))
 943           (add-hook 'imap-fetch-data-hook
 944                     (nnimap-make-callback article
 945                                           nnheader-callback-function
 946                                           nntp-server-buffer))
 947           (imap-fetch-asynch article part nil nnimap-server-buffer)
 948           (cons group article))))))
 949
 950 (deffoo nnimap-asynchronous-p ()
 951   t)
 952
 953 (deffoo nnimap-request-article (article &optional group server to-buffer)
 954   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 955       (nnimap-request-article-part
 956        article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail)
 957     (nnimap-request-article-part
 958      article "RFC822.PEEK" 'RFC822 group server to-buffer)))
 959
 960 (deffoo nnimap-request-head (article &optional group server to-buffer)
 961   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 962       (nnimap-request-article-part
 963        article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail)
 964     (nnimap-request-article-part
 965      article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer)))
 966
 967 (deffoo nnimap-request-body (article &optional group server to-buffer)
 968   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 969       (nnimap-request-article-part
 970        article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail)
 971     (nnimap-request-article-part
 972      article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer)))
 973
 974 (deffoo nnimap-request-group (group &optional server fast)
 975   (nnimap-request-update-info-internal
 976    group
 977    (gnus-get-info (gnus-group-prefixed-name
 978                    group (gnus-server-to-method (format "nnimap:%s" server))))
 979    server)
 980   (when (nnimap-possibly-change-group group server)
 981     (nnimap-before-find-minmax-bugworkaround)
 982     (let (info)
 983       (cond (fast group)
 984             ((null (setq info (nnimap-find-minmax-uid group t)))
 985              (nnheader-report 'nnimap "Could not get active info for %s"
 986                               group))
 987             (t
 988              (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0)
 989                               (max 1 (or (nth 1 info) 1))
 990                               (or (nth 2 info) 0) group)
 991              (nnheader-report 'nnimap "Group %s selected" group)
 992              t)))))
 993
 994 (defun nnimap-update-unseen (group &optional server)
 995   "Update the unseen count in `nnimap-mailbox-info'."
 996   (gnus-sethash
 997    (gnus-group-prefixed-name group server)
 998    (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server)
 999                                  nnimap-mailbox-info)))
1000      (list (nth 0 old) (nth 1 old)
1001            (imap-mailbox-status group 'unseen nnimap-server-buffer)
1002            (nth 3 old)))
1003    nnimap-mailbox-info))
1004
1005 (defun nnimap-close-group (group &optional server)
1006   (with-current-buffer nnimap-server-buffer
1007     (when (and (imap-opened)
1008                (nnimap-possibly-change-group group server))
1009       (nnimap-update-unseen group server)
1010       (case nnimap-expunge-on-close
1011         (always (progn
1012                   (imap-mailbox-expunge nnimap-close-asynchronous)
1013                   (unless nnimap-dont-close
1014                     (imap-mailbox-close nnimap-close-asynchronous))))
1015         (ask (if (and (imap-search "DELETED")
1016                       (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
1017                                              imap-current-mailbox)))
1018                  (progn
1019                    (imap-mailbox-expunge nnimap-close-asynchronous)
1020                    (unless nnimap-dont-close
1021                      (imap-mailbox-close nnimap-close-asynchronous)))
1022                (imap-mailbox-unselect)))
1023         (t (imap-mailbox-unselect)))
1024       (not imap-current-mailbox))))
1025
1026 (defun nnimap-pattern-to-list-arguments (pattern)
1027   (mapcar (lambda (p)
1028             (cons (car-safe p) (or (cdr-safe p) p)))
1029           (if (and (listp pattern)
1030                    (listp (cdr pattern)))
1031               pattern
1032             (list pattern))))
1033
1034 (deffoo nnimap-request-list (&optional server)
1035   (when (nnimap-possibly-change-server server)
1036     (with-current-buffer nntp-server-buffer
1037       (erase-buffer))
1038     (gnus-message 5 "nnimap: Generating active list%s..."
1039                   (if (> (length server) 0) (concat " for " server) ""))
1040     (nnimap-before-find-minmax-bugworkaround)
1041     (with-current-buffer nnimap-server-buffer
1042       (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern))
1043         (dolist (mbx (funcall nnimap-request-list-method
1044                               (cdr pattern) (car pattern)))
1045           (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx))
1046               (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1047                 (when info
1048                   (with-current-buffer nntp-server-buffer
1049                     (insert (format "\"%s\" %d %d y\n"
1050                                     mbx (or (nth 2 info) 0)
1051                                     (max 1 (or (nth 1 info) 1)))))))))))
1052     (gnus-message 5 "nnimap: Generating active list%s...done"
1053                   (if (> (length server) 0) (concat " for " server) ""))
1054     t))
1055
1056 (deffoo nnimap-request-post (&optional server)
1057   (let ((success t))
1058     (dolist (mbx (message-unquote-tokens
1059                   (message-tokenize-header
1060                    (message-fetch-field "Newsgroups") ", ")) success)
1061       (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
1062         (or (gnus-active to-newsgroup)
1063             (gnus-activate-group to-newsgroup)
1064             (if (gnus-y-or-n-p (format "No such group: %s.  Create it? "
1065                                        to-newsgroup))
1066                 (or (and (gnus-request-create-group
1067                           to-newsgroup gnus-command-method)
1068                          (gnus-activate-group to-newsgroup nil nil
1069                                               gnus-command-method))
1070                     (error "Couldn't create group %s" to-newsgroup)))
1071             (error "No such group: %s" to-newsgroup))
1072         (unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method))
1073           (setq success nil))))))
1074
1075 ;; Optional backend functions
1076
1077 (defun nnimap-string-lessp-numerical (s1 s2)
1078   "Return t if first arg string is less than second in numerical order."
1079   (cond ((string= s1 s2)
1080          nil)
1081         ((> (length s1) (length s2))
1082          nil)
1083         ((< (length s1) (length s2))
1084          t)
1085         ((< (string-to-number (substring s1 0 1))
1086             (string-to-number (substring s2 0 1)))
1087          t)
1088         ((> (string-to-number (substring s1 0 1))
1089             (string-to-number (substring s2 0 1)))
1090          nil)
1091         (t
1092          (nnimap-string-lessp-numerical (substring s1 1) (substring s2 1)))))
1093
1094 (deffoo nnimap-retrieve-groups (groups &optional server)
1095   (when (nnimap-possibly-change-server server)
1096     (gnus-message 5 "nnimap: Checking mailboxes...")
1097     (with-current-buffer nntp-server-buffer
1098       (erase-buffer)
1099       (nnimap-before-find-minmax-bugworkaround)
1100       (let (asyncgroups slowgroups)
1101         (if (null nnimap-retrieve-groups-asynchronous)
1102             (setq slowgroups groups)
1103           (dolist (group groups)
1104             (gnus-message 9 "nnimap: Quickly checking mailbox %s" group)
1105             (add-to-list (if (gnus-gethash-safe
1106                               (gnus-group-prefixed-name group server)
1107                               nnimap-mailbox-info)
1108                              'asyncgroups
1109                            'slowgroups)
1110                          (list group (imap-mailbox-status-asynch
1111                                       group '(uidvalidity uidnext unseen)
1112                                       nnimap-server-buffer))))
1113           (dolist (asyncgroup asyncgroups)
1114             (let ((group (nth 0 asyncgroup))
1115                   (tag   (nth 1 asyncgroup))
1116                   new old)
1117               (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer))
1118                 (if (or (not (string=
1119                               (nth 0 (gnus-gethash (gnus-group-prefixed-name
1120                                                     group server)
1121                                                    nnimap-mailbox-info))
1122                               (imap-mailbox-get 'uidvalidity group
1123                                                 nnimap-server-buffer)))
1124                         (not (string=
1125                               (nth 1 (gnus-gethash (gnus-group-prefixed-name
1126                                                     group server)
1127                                                    nnimap-mailbox-info))
1128                               (imap-mailbox-get 'uidnext group
1129                                                 nnimap-server-buffer))))
1130                     (push (list group) slowgroups)
1131                   (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
1132                                                 group server)
1133                                                nnimap-mailbox-info))))))))
1134         (dolist (group slowgroups)
1135           (if nnimap-retrieve-groups-asynchronous
1136               (setq group (car group)))
1137           (gnus-message 7 "nnimap: Mailbox %s modified" group)
1138           (imap-mailbox-put 'uidnext nil group nnimap-server-buffer)
1139           (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
1140                                                      nnimap-server-buffer))
1141               (let* ((info (nnimap-find-minmax-uid group 'examine))
1142                      (str (format "\"%s\" %d %d y\n" group
1143                                   (or (nth 2 info) 0)
1144                                   (max 1 (or (nth 1 info) 1)))))
1145                 (when (> (or (imap-mailbox-get 'recent group
1146                                                nnimap-server-buffer) 0)
1147                          0)
1148                   (push (list (cons group 0)) nnmail-split-history))
1149                 (insert str)
1150                 (when nnimap-retrieve-groups-asynchronous
1151                   (gnus-sethash
1152                    (gnus-group-prefixed-name group server)
1153                    (list (or (imap-mailbox-get
1154                               'uidvalidity group nnimap-server-buffer)
1155                              (imap-mailbox-status
1156                               group 'uidvalidity nnimap-server-buffer))
1157                          (or (imap-mailbox-get
1158                               'uidnext group nnimap-server-buffer)
1159                              (imap-mailbox-status
1160                               group 'uidnext nnimap-server-buffer))
1161                          (or (imap-mailbox-get
1162                               'unseen group nnimap-server-buffer)
1163                              (imap-mailbox-status
1164                               group 'unseen nnimap-server-buffer))
1165                          str)
1166                    nnimap-mailbox-info)))))))
1167     (gnus-message 5 "nnimap: Checking mailboxes...done")
1168     'active))
1169
1170 (deffoo nnimap-request-update-info-internal (group info &optional server)
1171   (when (nnimap-possibly-change-group group server)
1172     (when info;; xxx what does this mean? should we create a info?
1173       (with-current-buffer nnimap-server-buffer
1174         (gnus-message 5 "nnimap: Updating info for %s..."
1175                       (gnus-info-group info))
1176
1177         (when (nnimap-mark-permanent-p 'read)
1178           (let (seen unseen)
1179             ;; read info could contain articles marked unread by other
1180             ;; imap clients!  we correct this
1181             (setq seen (gnus-uncompress-range (gnus-info-read info))
1182                   unseen (imap-search "UNSEEN UNDELETED")
1183                   seen (gnus-set-difference seen unseen)
1184                   ;; seen might lack articles marked as read by other
1185                   ;; imap clients! we correct this
1186                   seen (append seen (imap-search "SEEN"))
1187                   ;; remove dupes
1188                   seen (sort seen '<)
1189                   seen (gnus-compress-sequence seen t)
1190                   ;; we can't return '(1) since this isn't a "list of ranges",
1191                   ;; and we can't return '((1)) since g-list-of-unread-articles
1192                   ;; is buggy so we return '((1 . 1)).
1193                   seen (if (and (integerp (car seen))
1194                                 (null (cdr seen)))
1195                            (list (cons (car seen) (car seen)))
1196                          seen))
1197             (gnus-info-set-read info seen)))
1198
1199         (mapcar (lambda (pred)
1200                   (when (or (eq (cdr pred) 'recent)
1201                             (and (nnimap-mark-permanent-p (cdr pred))
1202                                  (member (nnimap-mark-to-flag (cdr pred))
1203                                          (imap-mailbox-get 'flags))))
1204                     (gnus-info-set-marks
1205                      info
1206                      (gnus-update-alist-soft
1207                       (cdr pred)
1208                       (gnus-compress-sequence
1209                        (imap-search (nnimap-mark-to-predicate (cdr pred))))
1210                       (gnus-info-marks info))
1211                      t)))
1212                 gnus-article-mark-lists)
1213
1214         (when nnimap-importantize-dormant
1215           ;; nnimap mark dormant article as ticked too (for other clients)
1216           ;; so we remove that mark for gnus since we support dormant
1217           (gnus-info-set-marks
1218            info
1219            (gnus-update-alist-soft
1220             'tick
1221             (gnus-remove-from-range
1222              (cdr-safe (assoc 'tick (gnus-info-marks info)))
1223              (cdr-safe (assoc 'dormant (gnus-info-marks info))))
1224             (gnus-info-marks info))
1225            t))
1226
1227         (gnus-message 5 "nnimap: Updating info for %s...done"
1228                       (gnus-info-group info))
1229
1230         info))))
1231
1232 (deffoo nnimap-request-type (group &optional article)
1233   (if (and nnimap-news-groups (string-match nnimap-news-groups group))
1234       'news
1235     'mail))
1236
1237 (deffoo nnimap-request-set-mark (group actions &optional server)
1238   (when (nnimap-possibly-change-group group server)
1239     (with-current-buffer nnimap-server-buffer
1240       (let (action)
1241         (gnus-message 7 "nnimap: Setting marks in %s..." group)
1242         (while (setq action (pop actions))
1243           (let ((range (nth 0 action))
1244                 (what  (nth 1 action))
1245                 (cmdmarks (nth 2 action))
1246                 marks)
1247             ;; bookmark can't be stored (not list/range
1248             (setq cmdmarks (delq 'bookmark cmdmarks))
1249             ;; killed can't be stored (not list/range
1250             (setq cmdmarks (delq 'killed cmdmarks))
1251             ;; unsent are for nndraft groups only
1252             (setq cmdmarks (delq 'unsent cmdmarks))
1253             ;; cache flags are pointless on the server
1254             (setq cmdmarks (delq 'cache cmdmarks))
1255             ;; seen flags are local to each gnus
1256             (setq cmdmarks (delq 'seen cmdmarks))
1257             ;; recent marks can't be set
1258             (setq cmdmarks (delq 'recent cmdmarks))
1259             (when nnimap-importantize-dormant
1260               ;; flag dormant articles as ticked
1261               (if (memq 'dormant cmdmarks)
1262                   (setq cmdmarks (cons 'tick cmdmarks))))
1263             ;; remove stuff we are forbidden to store
1264             (mapc (lambda (mark)
1265                     (if (imap-message-flag-permanent-p
1266                          (nnimap-mark-to-flag mark))
1267                         (setq marks (cons mark marks))))
1268                   cmdmarks)
1269             (when (and range marks)
1270               (cond ((eq what 'del)
1271                      (imap-message-flags-del
1272                       (imap-range-to-message-set range)
1273                       (nnimap-mark-to-flag marks nil t)))
1274                     ((eq what 'add)
1275                      (imap-message-flags-add
1276                       (imap-range-to-message-set range)
1277                       (nnimap-mark-to-flag marks nil t)))
1278                     ((eq what 'set)
1279                      (imap-message-flags-set
1280                       (imap-range-to-message-set range)
1281                       (nnimap-mark-to-flag marks nil t)))))))
1282         (gnus-message 7 "nnimap: Setting marks in %s...done" group))))
1283   nil)
1284
1285 (defun nnimap-split-fancy ()
1286   "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
1287   (let ((nnmail-split-fancy nnimap-split-fancy))
1288     (nnmail-split-fancy)))
1289
1290 (defun nnimap-split-to-groups (rules)
1291   ;; tries to match all rules in nnimap-split-rule against content of
1292   ;; nntp-server-buffer, returns a list of groups that matched.
1293   (with-current-buffer nntp-server-buffer
1294     ;; Fold continuation lines.
1295     (goto-char (point-min))
1296     (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
1297       (replace-match " " t t))
1298     (if (functionp rules)
1299         (funcall rules)
1300       (let (to-groups regrepp)
1301         (catch 'split-done
1302           (dolist (rule rules to-groups)
1303             (let ((group (car rule))
1304                   (regexp (cadr rule)))
1305               (goto-char (point-min))
1306               (when (and (if (stringp regexp)
1307                              (progn
1308                                (if (not (stringp group))
1309                                    (setq group (eval group))
1310                                  (setq regrepp
1311                                        (string-match "\\\\[0-9&]" group)))
1312                                (re-search-forward regexp nil t))
1313                            (funcall regexp group))
1314                          ;; Don't enter the article into the same group twice.
1315                          (not (assoc group to-groups)))
1316                 (push (if regrepp
1317                           (nnmail-expand-newtext group)
1318                         group)
1319                       to-groups)
1320                 (or nnimap-split-crosspost
1321                     (throw 'split-done to-groups))))))))))
1322
1323 (defun nnimap-assoc-match (key alist)
1324   (let (element)
1325     (while (and alist (not element))
1326       (if (string-match (car (car alist)) key)
1327           (setq element (car alist)))
1328       (setq alist (cdr alist)))
1329     element))
1330
1331 (defun nnimap-split-find-rule (server inbox)
1332   (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule))
1333            (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule)))
1334       ;; extended format
1335       (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match
1336                                             server nnimap-split-rule))))
1337     nnimap-split-rule))
1338
1339 (defun nnimap-split-find-inbox (server)
1340   (if (listp nnimap-split-inbox)
1341       nnimap-split-inbox
1342     (list nnimap-split-inbox)))
1343
1344 (defun nnimap-split-articles (&optional group server)
1345   (when (nnimap-possibly-change-server server)
1346     (with-current-buffer nnimap-server-buffer
1347       (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server)))
1348         ;; iterate over inboxes
1349         (while (and (setq inbox (pop inboxes))
1350                     (nnimap-possibly-change-group inbox));; SELECT
1351           ;; find split rule for this server / inbox
1352           (when (setq rule (nnimap-split-find-rule server inbox))
1353             ;; iterate over articles
1354             (dolist (article (imap-search nnimap-split-predicate))
1355               (when (if (if (eq nnimap-split-download-body 'default)
1356                             nnimap-split-download-body-default
1357                           nnimap-split-download-body)
1358                         (and (nnimap-request-article article)
1359                              (with-current-buffer nntp-server-buffer (mail-narrow-to-head)))
1360                       (nnimap-request-head article))
1361                 ;; copy article to right group(s)
1362                 (setq removeorig nil)
1363                 (dolist (to-group (nnimap-split-to-groups rule))
1364                   (cond ((eq to-group 'junk)
1365                          (message "IMAP split removed %s:%s:%d" server inbox
1366                                   article)
1367                          (setq removeorig t))
1368                         ((imap-message-copy (number-to-string article)
1369                                             to-group nil 'nocopyuid)
1370                          (message "IMAP split moved %s:%s:%d to %s" server
1371                                   inbox article to-group)
1372                          (setq removeorig t)
1373                          (when nnmail-cache-accepted-message-ids
1374                            (with-current-buffer nntp-server-buffer
1375                              (let (msgid)
1376                                (and (setq msgid
1377                                           (nnmail-fetch-field "message-id"))
1378                                     (nnmail-cache-insert msgid
1379                                                          to-group
1380                                                          (nnmail-fetch-field "subject"))))))
1381                          ;; Add the group-art list to the history list.
1382                          (push (list (cons to-group 0)) nnmail-split-history))
1383                         (t
1384                          (message "IMAP split failed to move %s:%s:%d to %s"
1385                                   server inbox article to-group))))
1386                 (if (if (eq nnimap-split-download-body 'default)
1387                         nnimap-split-download-body-default
1388                       nnimap-split-download-body)
1389                     (widen))
1390                 ;; remove article if it was successfully copied somewhere
1391                 (and removeorig
1392                      (imap-message-flags-add (format "%d" article)
1393                                              "\\Seen \\Deleted")))))
1394           (when (imap-mailbox-select inbox);; just in case
1395             ;; todo: UID EXPUNGE (if available) to remove splitted articles
1396             (imap-mailbox-expunge)
1397             (imap-mailbox-close)))
1398         (when nnmail-cache-accepted-message-ids
1399           (nnmail-cache-close))
1400         t))))
1401
1402 (deffoo nnimap-request-scan (&optional group server)
1403   (nnimap-split-articles group server))
1404
1405 (deffoo nnimap-request-newgroups (date &optional server)
1406   (when (nnimap-possibly-change-server server)
1407     (with-current-buffer nntp-server-buffer
1408       (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
1409                     (if (> (length server) 0) " on " "") server)
1410       (erase-buffer)
1411       (nnimap-before-find-minmax-bugworkaround)
1412       (dolist (pattern (nnimap-pattern-to-list-arguments
1413                         nnimap-list-pattern))
1414         (dolist (mbx (imap-mailbox-lsub (cdr pattern) (car pattern) nil
1415                                         nnimap-server-buffer))
1416           (or (catch 'found
1417                 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1418                                                    nnimap-server-buffer))
1419                   (if (string= (downcase mailbox) "\\noselect")
1420                       (throw 'found t)))
1421                 nil)
1422               (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1423                 (when info
1424                   (insert (format "\"%s\" %d %d y\n"
1425                                   mbx (or (nth 2 info) 0)
1426                                   (max 1 (or (nth 1 info) 1)))))))))
1427       (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1428                     (if (> (length server) 0) " on " "") server))
1429     t))
1430
1431 (deffoo nnimap-request-create-group (group &optional server args)
1432   (when (nnimap-possibly-change-server server)
1433     (or (imap-mailbox-status group 'uidvalidity nnimap-server-buffer)
1434         (imap-mailbox-create group nnimap-server-buffer)
1435         (nnheader-report 'nnimap "%S"
1436                          (imap-error-text nnimap-server-buffer)))))
1437
1438 (defun nnimap-time-substract (time1 time2)
1439   "Return TIME for TIME1 - TIME2."
1440   (let* ((ms (- (car time1) (car time2)))
1441          (ls (- (nth 1 time1) (nth 1 time2))))
1442     (if (< ls 0)
1443         (list (- ms 1) (+ (expt 2 16) ls))
1444       (list ms ls))))
1445
1446 (eval-when-compile (require 'parse-time))
1447 (defun nnimap-date-days-ago (daysago)
1448   "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1449   (require 'parse-time)
1450   (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago)))
1451          (date (format-time-string
1452                 (format "%%d-%s-%%Y"
1453                         (capitalize (car (rassoc (nth 4 (decode-time time))
1454                                                  parse-time-months))))
1455                 time)))
1456     (if (eq ?0 (string-to-char date))
1457         (substring date 1)
1458       date)))
1459
1460 (defun nnimap-request-expire-articles-progress ()
1461   (gnus-message 5 "nnimap: Marking article %d for deletion..."
1462                 imap-current-message))
1463
1464 (defun nnimap-expiry-target (arts group server)
1465   (unless (eq nnmail-expiry-target 'delete)
1466     (with-temp-buffer
1467       (dolist (art arts)
1468         (nnimap-request-article art group server (current-buffer))
1469         ;; hints for optimization in `nnimap-request-accept-article'
1470         (let ((nnimap-current-move-article art)
1471               (nnimap-current-move-group group)
1472               (nnimap-current-move-server server))
1473           (nnmail-expiry-target-group nnmail-expiry-target group))))
1474     ;; It is not clear if `nnmail-expiry-target' somehow cause the
1475     ;; current group to be changed or not, so we make sure here.
1476     (nnimap-possibly-change-group group server)))
1477
1478 ;; Notice that we don't actually delete anything, we just mark them deleted.
1479 (deffoo nnimap-request-expire-articles (articles group &optional server force)
1480   (let ((artseq (gnus-compress-sequence articles)))
1481     (when (and artseq (nnimap-possibly-change-group group server))
1482       (with-current-buffer nnimap-server-buffer
1483         (let ((days (or (and nnmail-expiry-wait-function
1484                              (funcall nnmail-expiry-wait-function group))
1485                         nnmail-expiry-wait)))
1486           (cond ((or force (eq days 'immediate))
1487                  (let ((oldarts (imap-search
1488                                  (concat "UID "
1489                                          (imap-range-to-message-set artseq)))))
1490                    (when oldarts
1491                      (nnimap-expiry-target oldarts group server)
1492                      (when (imap-message-flags-add
1493                             (imap-range-to-message-set
1494                              (gnus-compress-sequence oldarts)) "\\Deleted")
1495                        (setq articles (gnus-set-difference
1496                                        articles oldarts))))))
1497                 ((numberp days)
1498                  (let ((oldarts (imap-search
1499                                  (format nnimap-expunge-search-string
1500                                          (imap-range-to-message-set artseq)
1501                                          (nnimap-date-days-ago days))))
1502                        (imap-fetch-data-hook
1503                         '(nnimap-request-expire-articles-progress)))
1504                    (when oldarts
1505                      (nnimap-expiry-target oldarts group server)
1506                      (when (imap-message-flags-add
1507                             (imap-range-to-message-set
1508                              (gnus-compress-sequence oldarts)) "\\Deleted")
1509                        (setq articles (gnus-set-difference
1510                                        articles oldarts)))))))))))
1511   ;; return articles not deleted
1512   articles)
1513
1514 (deffoo nnimap-request-move-article (article group server accept-form
1515                                              &optional last move-is-internal)
1516   (when (nnimap-possibly-change-server server)
1517     (save-excursion
1518       (let ((buf (get-buffer-create " *nnimap move*"))
1519             (nnimap-current-move-article article)
1520             (nnimap-current-move-group group)
1521             (nnimap-current-move-server nnimap-current-server)
1522             result)
1523         (gnus-message 10 "nnimap-request-move-article: this is an %s move"
1524                       (if move-is-internal
1525                           "internal"
1526                         "external"))
1527         ;; request the article only when the move is NOT internal
1528         (and (or move-is-internal
1529                  (nnimap-request-article article group server))
1530              (save-excursion
1531                (set-buffer buf)
1532                (buffer-disable-undo (current-buffer))
1533                (insert-buffer-substring nntp-server-buffer)
1534                (setq result (eval accept-form))
1535                (kill-buffer buf)
1536                result)
1537              (imap-message-flags-add
1538               (imap-range-to-message-set (list article))
1539               "\\Deleted" 'silent nnimap-server-buffer))
1540         result))))
1541
1542 (deffoo nnimap-request-accept-article (group &optional server last)
1543   (when (nnimap-possibly-change-server server)
1544     (let (uid)
1545       (if (setq uid
1546                 (if (string= nnimap-current-server nnimap-current-move-server)
1547                     ;; moving article within same server, speed it up...
1548                     (and (nnimap-possibly-change-group
1549                           nnimap-current-move-group)
1550                          (imap-message-copy (number-to-string
1551                                              nnimap-current-move-article)
1552                                             group 'dontcreate nil
1553                                             nnimap-server-buffer))
1554                   (with-current-buffer (current-buffer)
1555                     (goto-char (point-min))
1556                     ;; remove any 'From blabla' lines, some IMAP servers
1557                     ;; reject the entire message otherwise.
1558                     (when (looking-at "^From[^:]")
1559                       (delete-region (point) (progn (forward-line) (point))))
1560                     ;; turn into rfc822 format (\r\n eol's)
1561                     (while (search-forward "\n" nil t)
1562                       (replace-match "\r\n"))
1563                     (when nnmail-cache-accepted-message-ids
1564                       (nnmail-cache-insert (nnmail-fetch-field "message-id")
1565                                            group
1566                                            (nnmail-fetch-field "subject"))))
1567                   (when (and last nnmail-cache-accepted-message-ids)
1568                     (nnmail-cache-close))
1569                   ;; this 'or' is for Cyrus server bug
1570                   (or (null (imap-current-mailbox nnimap-server-buffer))
1571                       (imap-mailbox-unselect nnimap-server-buffer))
1572                   (imap-message-append group (current-buffer) nil nil
1573                                        nnimap-server-buffer)))
1574           (cons group (nth 1 uid))
1575         (nnheader-report 'nnimap (imap-error-text nnimap-server-buffer))))))
1576
1577 (deffoo nnimap-request-delete-group (group force &optional server)
1578   (when (nnimap-possibly-change-server server)
1579     (with-current-buffer nnimap-server-buffer
1580       (if force
1581           (or (null (imap-mailbox-status group 'uidvalidity))
1582               (imap-mailbox-delete group))
1583         ;; UNSUBSCRIBE?
1584         t))))
1585
1586 (deffoo nnimap-request-rename-group (group new-name &optional server)
1587   (when (nnimap-possibly-change-server server)
1588     (imap-mailbox-rename group new-name nnimap-server-buffer)))
1589
1590 (defun nnimap-expunge (mailbox server)
1591   (when (nnimap-possibly-change-group mailbox server)
1592     (imap-mailbox-expunge nil nnimap-server-buffer)))
1593
1594 (defun nnimap-acl-get (mailbox server)
1595   (when (nnimap-possibly-change-server server)
1596     (and (imap-capability 'ACL nnimap-server-buffer)
1597          (imap-mailbox-acl-get mailbox nnimap-server-buffer))))
1598
1599 (defun nnimap-acl-edit (mailbox method old-acls new-acls)
1600   (when (nnimap-possibly-change-server (cadr method))
1601     (unless (imap-capability 'ACL nnimap-server-buffer)
1602       (error "Your server does not support ACL editing"))
1603     (with-current-buffer nnimap-server-buffer
1604       ;; delete all removed identifiers
1605       (mapc (lambda (old-acl)
1606               (unless (assoc (car old-acl) new-acls)
1607                 (or (imap-mailbox-acl-delete (car old-acl) mailbox)
1608                     (error "Can't delete ACL for %s" (car old-acl)))))
1609             old-acls)
1610       ;; set all changed acl's
1611       (mapc (lambda (new-acl)
1612               (let ((new-rights (cdr new-acl))
1613                     (old-rights (cdr (assoc (car new-acl) old-acls))))
1614                 (unless (and old-rights new-rights
1615                              (string= old-rights new-rights))
1616                   (or (imap-mailbox-acl-set (car new-acl) new-rights mailbox)
1617                       (error "Can't set ACL for %s to %s" (car new-acl)
1618                              new-rights)))))
1619             new-acls)
1620       t)))
1621
1622 \f
1623 ;;; Internal functions
1624
1625 ;;
1626 ;; This is confusing.
1627 ;;
1628 ;; mark      => read, tick, draft, reply etc
1629 ;; flag      => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1630 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1631 ;;
1632 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1633 ;; world, but we cheat.  Mark == gnus-article-mark-lists + '(read . read).
1634 ;;
1635
1636 (defconst nnimap-mark-to-predicate-alist
1637   (mapcar
1638    (lambda (pair)                       ; cdr is the mark
1639      (or (assoc (cdr pair)
1640                 '((read . "SEEN")
1641                   (tick . "FLAGGED")
1642                   (draft . "DRAFT")
1643                   (recent . "RECENT")
1644                   (reply . "ANSWERED")))
1645          (cons (cdr pair)
1646                (format "KEYWORD gnus-%s" (symbol-name (cdr pair))))))
1647    (cons '(read . read) gnus-article-mark-lists)))
1648
1649 (defun nnimap-mark-to-predicate (pred)
1650   "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1651 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1652 to be used within a IMAP SEARCH query."
1653   (cdr (assq pred nnimap-mark-to-predicate-alist)))
1654
1655 (defconst nnimap-mark-to-flag-alist
1656   (mapcar
1657    (lambda (pair)
1658      (or (assoc (cdr pair)
1659                 '((read . "\\Seen")
1660                   (tick . "\\Flagged")
1661                   (draft . "\\Draft")
1662                   (recent . "\\Recent")
1663                   (reply . "\\Answered")))
1664          (cons (cdr pair)
1665                (format "gnus-%s" (symbol-name (cdr pair))))))
1666    (cons '(read . read) gnus-article-mark-lists)))
1667
1668 (defun nnimap-mark-to-flag-1 (preds)
1669   (if (and (not (null preds)) (listp preds))
1670       (cons (nnimap-mark-to-flag (car preds))
1671             (nnimap-mark-to-flag (cdr preds)))
1672     (cdr (assoc preds nnimap-mark-to-flag-alist))))
1673
1674 (defun nnimap-mark-to-flag (preds &optional always-list make-string)
1675   "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1676 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1677 be used in a STORE FLAGS command."
1678   (let ((result (nnimap-mark-to-flag-1 preds)))
1679     (setq result (if (and (or make-string always-list)
1680                           (not (listp result)))
1681                      (list result)
1682                    result))
1683     (if make-string
1684         (mapconcat (lambda (flag)
1685                      (if (listp flag)
1686                          (mapconcat 'identity flag " ")
1687                        flag))
1688                    result " ")
1689       result)))
1690
1691 (defun nnimap-mark-permanent-p (mark &optional group)
1692   "Return t iff MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1693   (imap-message-flag-permanent-p (nnimap-mark-to-flag mark)))
1694
1695 (when nnimap-debug
1696   (require 'trace)
1697   (buffer-disable-undo (get-buffer-create nnimap-debug-buffer))
1698   (mapcar (lambda (f) (trace-function-background f nnimap-debug-buffer))
1699           '(
1700             nnimap-possibly-change-server
1701             nnimap-verify-uidvalidity
1702             nnimap-find-minmax-uid
1703             nnimap-before-find-minmax-bugworkaround
1704             nnimap-possibly-change-group
1705             ;;nnimap-replace-whitespace
1706             nnimap-retrieve-headers-progress
1707             nnimap-retrieve-which-headers
1708             nnimap-group-overview-filename
1709             nnimap-retrieve-headers-from-file
1710             nnimap-retrieve-headers-from-server
1711             nnimap-retrieve-headers
1712             nnimap-open-connection
1713             nnimap-open-server
1714             nnimap-server-opened
1715             nnimap-close-server
1716             nnimap-request-close
1717             nnimap-status-message
1718             ;;nnimap-demule
1719             nnimap-request-article-part
1720             nnimap-request-article
1721             nnimap-request-head
1722             nnimap-request-body
1723             nnimap-request-group
1724             nnimap-close-group
1725             nnimap-pattern-to-list-arguments
1726             nnimap-request-list
1727             nnimap-request-post
1728             nnimap-retrieve-groups
1729             nnimap-request-update-info-internal
1730             nnimap-request-type
1731             nnimap-request-set-mark
1732             nnimap-split-to-groups
1733             nnimap-split-find-rule
1734             nnimap-split-find-inbox
1735             nnimap-split-articles
1736             nnimap-request-scan
1737             nnimap-request-newgroups
1738             nnimap-request-create-group
1739             nnimap-time-substract
1740             nnimap-date-days-ago
1741             nnimap-request-expire-articles-progress
1742             nnimap-request-expire-articles
1743             nnimap-request-move-article
1744             nnimap-request-accept-article
1745             nnimap-request-delete-group
1746             nnimap-request-rename-group
1747             gnus-group-nnimap-expunge
1748             gnus-group-nnimap-edit-acl
1749             gnus-group-nnimap-edit-acl-done
1750             nnimap-group-mode-hook
1751             nnimap-mark-to-predicate
1752             nnimap-mark-to-flag-1
1753             nnimap-mark-to-flag
1754             nnimap-mark-permanent-p
1755             )))
1756
1757 (provide 'nnimap)
1758
1759 ;;; nnimap.el ends here