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

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